10

roxygen2開発中のパッケージのデータセットを文書化するために使用しています。roxygen を使用してデータセットを文書化できることは知っていますが、シェーンの答えは最終的にハックを示唆していますが、これは避けたいと思います。だから、私の質問は：

データの roxygen ドキュメントはどこに置くべきですか?

現在、/R フォルダーにanorexia.sub.roxygen拒食症データセットのデータ ドキュメント ファイル ( ) があります。

マイ パッケージ ディレクトリ

私が知る限り、それが roxygen2 が検索する唯一の場所だからです。

#' Family Treatment Weight change data for young female anorexia patients.
#' 

#' 
#' The MASS package includes the dataset \code{anorexia}, containing pre and
#' post treatment weights for young female anorexia patients.  This is a subset
#' of those data, containing only those patients who received Family Treatment.
#' 
#' 
#' @name anorexia.sub
#' @docType data
#' @format A dataframe with 17 observations on the following 2 variables, no
#'   NAs.
#'
#' \describe{
#' 
#' \item{list("Prewt")}{Pretreatment weight of subject, in pounds.}
#' 
#' \item{list("Postwt")}{Postreatment weight of subject, in pounds.}
#' 
#' }
#' @references Venables, W. N. and Ripley, B. D. (2002) Modern Applied
#'   Statistics with S. Fourth edition. Springer.
#' @source Hand, D. J., Daly, F., McConway, K., Lunn, D. and Ostrowski, E. eds
#'   (1993) A Handbook of Small Data Sets. Chapman & Hall, Data set 285 (p.
#'   229)
#' @keywords datasets
NULL

roxygen2ドキュメントをうまく生成します。しかし、それはanorexia.sub.roxygen.R私のCollateフィールドに追加しますDESCRIPTION:

Collate:
    'granova.R'
    'theme-defaults.R'
    'granovagg.1w.R'
    'granovagg.contr.R'
    'granovagg.ds.R'
    'help.R'
    'anorexia.sub.roxygen.R'

私の質問は次のとおりだと思います：どうすればroxygen2を手に入れることができますか

  1. roxygen ブロックからデータ ドキュメントを自動的に生成し、
  2. Collate呼び出しにデータ ドキュメント ファイルを追加しない、および
  3. ハックを必要とする解決策を避ける
4

1 に答える 1

16

パッケージ レベルと関数レベルでパッケージを文書化することをお勧めします。そのため、 (たとえば、あなたの場合)Rという名前のフォルダー内に常にファイルがあり、パッケージ ドキュメントとデータ ドキュメントを保持しています。packagename-package.RgranovaGG-package.R

したがって、granovaGG-package.Rファイルは次のようになります。

#' One sentence summary of your package.
#' 
#' More detail
#' ...
#' @name granovaGG-package
#' @aliases granovaGG
#' @docType package
#' @title One sentence summary of your package.
#' @author \email{your.name@@email.com}
#' @keywords package
#' @seealso \code{\link{...}}
NULL
#' Your dataset documentation goes here.
#' 
#' Exactly as in your example.
#' @docType data
#' etc.
#' ...
NULL
于 2011-08-17T06:11:20.250 に答える