README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r remedy01, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  eval = FALSE
)
```

# Hướng dẫn tạo package

<!-- badges: start -->
<!-- badges: end -->

### Cài 1 số packages hỗ trợ

```{r remedy001}
#install.packages(c("devtools", "roxygen2", "usethis", "available"))
library(devtools)
library(roxygen2)
library(usethis)

```


### Kiểm tra xem tên package đã có trên cran chưa

Nếu có ý định upload package này lên cran thì có thể dùng hàm này để kiểm tra xem package đã có trên cran hay chưa.

```{r remedy002}
library(available)
available("git.manual")
```


### Tạo package

Tạo package và thêm git vào.

```{r remedy003}

usethis::create_package("~/Desktop/git.manual")
use_git()
use_github()

```

### Chỉnh sửa DESCRIPTION

Có thể chỉnh sửa trực tiếp bằng tay (làm cách này khi mất code thì phải làm đi làm lại). 
Nên trong phần này mình sẽ chỉnh sửa file DESCRIPTION sử dụng package __desc__

```{r remedy02}
library(desc)
```


- Xóa DESCRIPTION mặc định
```{r remedy004}

unlink("DESCRIPTION")

```

- Tạo mới và clean file DESCRIPTION

Do package sử dụng object R6, nên có thể dùng hàm hoặc toán tử $ để chỉnh sửa các thành phần của object
```{r remedy005}

my_desc <- description$new("!new")

```

- Đặt tên package của bạn

```{r remedy006}

my_desc$set("Package", "git.manual")

```

- Tên của tác giả

```{r remedy007}

my_desc$set("Authors@R", "person('Ngoc Binh', 'Nguyen', email = 'nguyenngocbinhneu@gmail.com', role = c('cre', 'aut'))")

```

- Xóa 1 số trường liên quan đến tác giả hoặc người duy trì

```{r remedy008}

my_desc$del("Maintainer")

```

- Đặt phiên bản

```{r remedy009}

my_desc$set_version("0.0.0.9000")

```

- Title của package

```{r remedy010}

my_desc$set(Title = "HOW TO USING GIT")

```

- Mô tả về package

```{r remedy011}

my_desc$set(Description = "A long description of this super package I'm working on.")

```

- urls

```{r remedy012}

my_desc$set("URL", "http://this")
my_desc$set("BugReports", "http://that")

```

- Tạo file DESCRIPTION mới

```{r remedy013}

my_desc$write(file = "DESCRIPTION")

```


### Tạo file license

Sau khi đã chỉnh sửa file DESCRIPTION ở trên. Phần này sẽ tạo ra file license. Ví dụ với MIT license.

```{r remedy04}

# options(usethis.full_name = "Nguyen Ngoc Binh")
use_mit_license("Nguyen Ngoc Binh")
use_gpl3_license()
use_apl2_license()
use_cc0_license()

```



### Thêm readme

```{r remedy05}

use_readme_rmd()

```



### Thêm raw data

__use_data_raw()__ tạo ra folder data-raw. Trong này sẽ chứa code để setup raw data.

```{r remedy06}

use_data_raw()

```


### Thêm file chứa các nhóm hàm

__user_r()__ tạo ra 1 file .R trong folder /R/

```{r remedy07}

use_r("sfa")

```


### testthat

```{r remedy08}

use_testthat()
use_test("function_name")

```


### Thêm packages dependencies

```{r remedy09}

use_package("dplyr")
use_package("purrr")

```


### Sử dụng file new để cập nhật những thay đổi

```{r remedy10}

use_news_md()

```


### Thêm hướng dẫn sử dụng/ báo cáo đầu ra

```{r remedy11}

use_vignette("git.manual", "Simulate git")

```


### Chỉnh sửa version

```{r remedy12}

use_version()

```

### Tạo các help file 

Đây là những file .md được lưu trong folder __man/__

```{r remedy13}

use_roxygen_md()

```

### Format lại file DESCRIPTION
```{r}
use_tidy_description()
```

### Tham khảo thêm

```{r}
use_travis()
use_appveyor()
use_coverage(type = c("codecov"))
use_spell_check()
```