R Language
지붕 2

매개 변수

roxygen2로 패키지 문서화하기

roxygen2로 글쓰기

roxygen2 는 Hadley Wickham이 문서 작성을 용이하게하기 위해 만든 패키지입니다.

#' 시작하는 줄에 R 스크립트 안에 문서를 포함시킬 수 있습니다. 문서에 전달 된 여러 매개 변수는 @ 시작합니다. 예를 들어 패키지 작성자는 다음과 같이 작성됩니다.

#' @author The Author

예를 들어, 다음 함수를 문서화하고자한다면 :

mean<-function(x) sum(x)/length(x)

우리는이 함수에 작은 설명을 쓰고 다음과 같이 매개 변수를 설명하기를 원할 것입니다 (각 행에 대해서는 나중에 설명 할 것입니다).

#' Mean
#'
#' A function to compute the mean of a vector
#' @param x A numeric vector
#' @keyword mean
#' @importFrom base sum
#' @export
#' @examples
#' mean(1:3)
#' \dontrun{ mean(1:1e99) }
mean<-function(x) sum(x)/length(x)

• 첫 번째 줄 #' Mean 은 문서의 제목이며, 다음 줄은 코퍼스를 만듭니다.
• 함수의 각 매개 변수는 관련 @param 통해 상세하게 설명해야합니다. @export 는이 함수 이름을 내 @export 것을 나타내므로 패키지가로드 될 때 호출 할 수 있습니다.
• @keyword 는 도움을 찾을 때 관련 키워드를 제공합니다.
• @importFrom 은이 함수 나 패키지에서 사용될 패키지에서 가져올 모든 함수를 나열합니다. @import 를 사용하여 패키지의 완전한 네임 스페이스를 가져올 수 있습니다.
• 예제는 @example 태그 아래에 작성됩니다.
  • 첫 번째 패키지는 패키지가 빌드 될 때 평가됩니다.
  • 두 번째 것은 \dontrun 명령으로 인해 - 보통 긴 계산을 방지하지 않습니다 -.

문서 작성

문서는 devtools::document() 사용하여 만들 수 있습니다. devtools::check() 는 자동으로 문서를 만들고 함수의 문서에서 누락 된 인수를 경고로보고합니다.