roxygen2

록시겐2

roxygen2의 전제는 간단합니다. 정의 옆에 주석으로 함수를 설명하면 roxygen2는 소스 코드와 주석을 처리하여 man/ , NAMESPACE 및 필요한 경우 DESCRIPTION 의 Collate 필드에 .Rd 파일을 자동으로 생성합니다.

설치

 # Install roxygen2 from CRAN
install.packages( " roxygen2 " )

# Or the development version from GitHub:
# install.packages("pak")
pak :: pak( " r-lib/roxygen2 " )

용법

roxygen2의 전제는 간단합니다. 정의 옆에 주석으로 함수를 설명하면 roxygen2는 소스 코드와 주석을 처리하여 man/ 디렉터리에 Rd 파일을 생성합니다. 다음은 stringr 패키지의 간단한 예입니다.

 # ' The length of a string
# '
# ' Technically this returns the number of "code points", in a string. One
# ' code point usually corresponds to one character, but not always. For example,
# ' an u with a umlaut might be represented as a single character or as the
# ' combination a u and an umlaut.
# '
# ' @inheritParams str_detect
# ' @return A numeric vector giving number of characters (code points) in each
# '    element of the character vector. Missing string have missing length.
# ' @seealso [stringi::stri_length()] which this function wraps.
# ' @export
# ' @examples
# ' str_length(letters)
# ' str_length(NA)
# ' str_length(factor("abc"))
# ' str_length(c("i", "like", "programming", NA))
str_length <- function ( string ) {
}

roxygenise() (또는 devtools::document() ) 패키지를 사용할 때 이러한 주석은 ?str_length 입력할 때 표시되는 문서를 생성하기 위해 R이 사용하는 .Rd 로 자동 변환됩니다.

자세히 알아보기

시작하려면 먼저 vignette("roxygen2") 읽어보세요. 그런 다음 생성하려는 특정 패키지 구성 요소에 대해 자세히 알아보세요.

• vignette("rd") 로 시작하여 roxygen2로 함수를 문서화하는 방법을 알아보세요.

• vignette("rd-other") 데이터세트, 패키지 자체, R의 OOP 시스템에서 사용되는 다양한 부분과 같은 다른 항목을 문서화하는 방법을 설명합니다.

• vignette("rd-formatting") roxygen2의 rmarkdown 지원에 대한 세부 정보를 제공합니다.

• vignette("reuse") 여러 위치에서 문서를 재사용하는 데 사용할 수 있는 도구를 보여줍니다.

• vignette("namespace") NAMESPACE 파일을 생성하는 방법, R에서 네임스페이스가 작동하는 방법, 패키지에 필요한 것과 제공되는 사항을 구체적으로 지정하기 위해 roxygen2를 사용하는 방법을 설명합니다.

• DESCRIPTION 의 Collate 필드에 대해서는 ?update_collate() 참조하세요.