Как я могу документировать наборы данных, не добавляя их в поле Collate? - PullRequest
Новая
       15

Как я могу документировать наборы данных, не добавляя их в поле Collate?

10 голосов
/ 17 августа 2011

Я использую roxygen2 для документирования наборов данных для разрабатываемого пакета.Я знаю, что вы можете использовать roxygen для документирования набора данных , но ответ Шейна в конечном итоге предполагает взлом, которого я предпочел бы избежать.Итак, мой вопрос:

Куда я должен поместить документацию по содержанию кислорода для данных?

У меня в настоящее время есть файл документации по данным (anorexia.sub.roxygen) для набора данных по анорексии в моем / Rпапка

My Package Directory

, потому что, насколько я могу судить, это единственное место, где ее будет искать 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. избегайте решения, которое требует взлома

1 Ответ

16 голосов
/ 17 августа 2011

Поскольку рекомендуется документировать ваш пакет на уровне пакета , а также на уровне функции , в папке R всегда есть файл с именем packagename-package.R ( например, granovaGG-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
...