10.4 R 패키지 문서화

roxygen2 패키지를 사용하여 R 패키지에 주석을 포함할 수 있다. 먼저 다음 명령을 사용하여 패키지를 설치해야 한다. install.packages("roxygen2"). 그러면 필요한 지원 패키지와 함께 roxygen2 라이브러리가 설치된다.

다음 단계는 구축 도구를 구성하는 것이다. 메뉴의 “Build”로 이동한 다음 “Configure Build Tools…”를 선택한다. 그러면 그림 10.3과 같은 대화 상자가 나타난다.

그림 10.3: 빌드 도구 구성

“Generate documentation with Roxygen(Roxygen으로 문서 생성)” 확인란을 클릭한다. 그런 다음 “Configure(구성)…” 버튼을 클릭하면 그림 10.4와 같은 대화 상자가 나타난다.

그림 10.4: Roxygen 빌드 옵션

“Install and Restart(설치 및 다시 시작)” 확인란을 확인하라. 이제 R 패키지를 구축할 때 제공하는 필드를 기반으로 문서가 자동으로 생성된다. 백틱 # ’을 포함하는 특수 주석이 있는 문서를 포함한다. 각 필드 이름은 @로 시작한다. 몇 가지 일반적인 필드 유형에는 @name, @title 그리고 @description이 있다. 예를 들어 다음은 hello 함수 문서에 포함할 수있는 내용이다.

# Hello, world!
#
# This is an example function named 'hello'
# which prints Hey there!.
#
#' @name hello
#' @aliases hello
#' @title Hello World
#' @usage hello()
#' @description Prints 'Hey there!'
#' @examples hello()
hello <- function() {
            print("Hey there!")
}

이제 R 패키지를 구축할 때 도움말 문서에 그림 10.5에 표시된 대로 위에 포함된 내용이 반영된다.

그림 10.5: 사용자 지정 도움말 문서

도움말 파일에서 hello world 메시지가 함수에서 변경되었음을 반영하도록 설명 필드를 변경했다.