목록 항목의 Roxygen 문서

Question

나는 Roxygen을 배우며 지금까지 좋은 진전을 이루고있다. 필자가 작업하고있는 대부분의 패키지를 문서화 할 수 있었지만 제대로되지 않는 곳이 몇 군데 있습니다.

##' Test Roxygen Comments 
##' 
##' This is a test of the Roxygen System. Had this been actual 
##' documentation, it may have contained information about the 
##' directives and/or structures below. 
##' 
##' @name simple 
##' @docType data 
##' @rdname simple 

variable <- list(
       ##' itema comments 
       itema <- c("bing", "bang", "bong"), 

       ##' itemb comments 
       itemb <- "fooflakes" 
) 

##' More info abuot variable! 
##' @rdname simple 

list() 안에있는 의견은 그냥 내가 이것을 확인했습니다 Roxygen에 의해 삭제됩니다 : 다음과 같은 최소한의 R을 고려하시기 바랍니다

> parse.file("package-test/R/simple.R") 
$`1` 
$`1`$description 
[1] "Test Roxygen Comments\n\nThis is a test of the Roxygen System. Had this been actual\ndocumentation, it may have contained information about the\ndirectives and/or structures below.\n\n" 

$`1`$name 
[1] "simple\n" 

$`1`$docType 
[1] "data" 

$`1`$rdname 
[1] "simple" 

$`1`$assignee 
[1] "variable" 

$`1`$srcref 
$`1`$srcref$filename 
[1] "package-test/R/simple.R" 

$`1`$srcref$lloc 
[1] 11 1 17 1 1 1 

나는 인프라를 설정 옵션을 가지고 I 개별 옵션을 문서화하기 위해 Roxygen을 사용하고 싶습니다. 내가 코멘트를 들여 썼는지 여부는 문제가되지 않는 것처럼 보입니다. 왼쪽으로 이동하면 도움이되지 않습니다. 모든 블록에 @rdname을 추가하는 것은 도움이되지 않습니다. 나는 단지 존재하지 않는 행동을 기대하고 있는가? 또 다른 질문으로 받아 들여지는 대답은 우리가 어디에서나 Roxygen 주석을 넣을 수 있으며 수집 될 것이라고 말했다.

그래서 두 가지 : 내가 무엇을 놓치고 있습니까? 내 시도가 마음에 들지 않으면 다른 사람들이 개별 데이터 항목을 어떻게 문서화합니까?

감사합니다.

Answer 1

Roxygen은 그렇게하지 않습니다. 나는 5 명 이상의 캐릭터가 공식적인 대답이 필요하다.