R package 만들기 1

패키지 만들기

먼저 RStudio를 실행하고, usethis라는 패키지를 먼저 설치해줍니다. usethis에는 R 패키지 개발에 있어 여러 유용한 함수들이 들어있고, 이는 공식 홈페이지인 https://usethis.r-lib.org/ 에서 확인할 수 있습니다. (웬만한 R 패키지 세팅에 대한 기능은 대부분 포함되어 있기 떄문에, 패키지에 포함할 함수 코드부분을 제외한 설정에 있어서는 되도록 usethis 패키지에 내장된 함수를 사용하기를 권장합니다!)

install.packages("usethis") 

usethis 패키지 안의 usethis::create_package()라는 함수를 이용하여 패키지를 생성할 수 있는데요. 다음과 같이 함수 인자로 Rproject_저장경로/패키지_이름을 넣어주면 됩니다. (여기서는 fda.manifold라는 패키지를 만들어보겠습니다.)

usethis::create_package("~/Desktop/Rproject/fda.manifold")

✓ Creating '/Users/hyunsung/Desktop/Rproject/fda.manifold/'
✓ Setting active project to '/Users/hyunsung/Desktop/Rproject/fda.manifold'
✓ Creating 'R/'
✓ Writing 'DESCRIPTION'
Package: fda.manifold
Title: What the Package Does (One Line, Title Case)
Version: 0.0.0.9000
Authors@R (parsed):
    * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID)
Description: What the package does (one paragraph).
License: `use_mit_license()`, `use_gpl3_license()` or friends to
    pick a license
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
✓ Writing 'NAMESPACE'
✓ Writing 'fda.manifold.Rproj'
✓ Adding '^fda\\.manifold\\.Rproj$' to '.Rbuildignore'
✓ Adding '.Rproj.user' to '.gitignore'
✓ Adding '^\\.Rproj\\.user$' to '.Rbuildignore'
✓ Opening '/Users/hyunsung/Desktop/Rproject/fda.manifold/' in new RStudio session
✓ Setting active project to '<no active project>'

그럼 위의 결과가 나오면서 새로운 RStudio 창이 열리게 되고, 아래의 그림의 구조를 가지는 Rproject가 생성되게 됩니다.

패키지 document 생성

usethis::use_package_doc()

✓ Setting active project to '/Users/hyunsung/Desktop/Rproject/fda.manifold'
✓ Writing 'R/fda.manifold-package.R'
• Modify 'R/fda.manifold-package.R'

git 사용

GitHub에 패키지를 업로드하기 위해서, git을 사용하도록 설정해주어야 하는데요. 다음의 코드를 입력하여 현재 Rproject를 git 폴더형태로 만들 수 있습니다.

usethis::use_git()

✓ Initialising Git repo
✓ Adding '.Rhistory', '.Rdata', '.httr-oauth', '.DS_Store' to '.gitignore'
There are 6 uncommitted files:
* '.gitignore'
* '.Rbuildignore'
* 'DESCRIPTION'
* 'fda.manifold.Rproj'
* 'NAMESPACE'
* 'R/'
Is it ok to commit them?

1: Negative
2: No way
3: Yeah

Selection: 3
✓ Adding files
✓ Making a commit with message 'Initial commit'
• A restart of RStudio is required to activate the Git pane
Restart now?

1: Absolutely not
2: No
3: Definitely

Selection: 3

GitHub 연결 및 repository 생성

이 부분은 기존에 RStudio를 본인의 GitHub 계정과 연결되어 있는 경우에 가능합니다!

로컬에서 git 폴더를 만들었으니, 이제 GitHub 원격저장소에 올리면 끝입니다! 다음의 코드를 실행하면, 자동으로 본인의 GitHub에 패키지 이름으로 repository를 생성해주고 push까지 해주게 됩니다.

usethis::use_github()

ℹ Defaulting to 'https' Git protocol
✓ Setting active project to '/Users/hyunsung/Desktop/Rproject/fda.manifold'
✓ Checking that current branch is default branch ('master')
✓ Creating GitHub repository 'statKim/fda.manifold'
✓ Setting remote 'origin' to 'https://github.com/statKim/fda.manifold.git'
✓ Setting URL field in DESCRIPTION to 'https://github.com/statKim/fda.manifold'
✓ Setting BugReports field in DESCRIPTION to 'https://github.com/statKim/fda.manifold/issues'
There is 1 uncommitted file:
* 'DESCRIPTION'
Is it ok to commit it?

1: For sure
2: Absolutely not
3: Not now

Selection: 1
✓ Adding files
✓ Making a commit with message 'Add GitHub links to DESCRIPTION'
✓ Pushing 'master' branch to GitHub and setting 'origin/master' as upstream branch
✓ Opening URL 'https://github.com/statKim/fda.manifold'

그리고 자동으로 창 하나가 열리면서 다음의 GitHub repository에 잘 업로드되어 있는 것을 확인할 수 있습니다.

Reference

• https://r-pkgs.org/whole-game.html
• http://www.danieldsjoberg.com/writing-R-packages/