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

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

Где я могу разместить документацию на основе кислорода для данных?

В настоящее время у меня есть файл документации данных (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 создает документацию просто отлично. Но затем ADDS 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

  • автоматически создает документацию данных из блоков roxygen,
  • НЕ добавить файл документации данных к вызову Collate, AND
  • избегайте решения, которое требует взлома.

Ответ 1

Поскольку это хорошая практика для документирования вашего пакета на уровне , а также , у меня всегда есть файл внутри папки 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{[email protected]@email.com}
#' @keywords package
#' @seealso \code{\link{...}}
NULL
#' Your dataset documentation goes here.
#' 
#' Exactly as in your example.
#' @docType data
#' etc.
#' ...
NULL