リストアイテムの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のコメントを置くことができ、収集されるということでした。

2つ折り：私は上記のものが紛失していますが、私の試行のように他人が個々のデータ項目をどのように文書化していますか？

ありがとうございました！

Answer 1

Roxygenはそうしていません。私は正式な答えに5文字以上必要です。