Como posso documentar conjuntos de dados com Roxygen?

Question

É possível incluir arquivos .r no diretório de dados do meu pacote no processo roxygen?

Eu coloquei vários arquivos .r no diretório de dados. Quando são adquiridos com dados (), eles lêem em arquivos de dados brutos e executam algumas transformações.

Answer 1

O Roxygen pode ser usado em qualquer lugar dentro de um arquivo R (em outras palavras, ele não precisa ser seguido por uma função). Também pode ser usado para documentar qualquer doctype na documentação R.

Então você pode apenas documentar seus dados em um bloco separado (algo assim):

#' This is data to be included in my package
#'
#' @name data-name
#' @docType data
#' @author My Name \email{blahblah@@roxygen.org}
#' @references \url{data_blah.com}
#' @keywords data
NULL

Answer 2

A partir de roxygen2> 4.0.0, você pode documentar o objeto de dados definido em outro lugar, documentando o nome do objeto definido como uma string:

#' This is data to be included in my package
#'
#' @author My Name \email{blahblah@@roxygen.org}
#' @references \url{data_blah.com}
"data-name"

Answer 3

Achei útil estudar os exemplos no pacote GGPlot2.

Ver ggplot2.r no github

Algumas coisas de nota:

• Todo o código roxygen para conjuntos de dados pode ser incluído em um único .r arquivo no R diretório do pacote.

Veja para exemplos, o diamonds conjunto de dados:

#' Prices of 50,000 round cut diamonds
#'
#' A dataset containing the prices and other attributes of almost 54,000
#'  diamonds. The variables are as follows:
#'
#' \itemize{
#'   \item price. price in US dollars (\$326--\$18,823)
#'   \item carat. weight of the diamond (0.2--5.01)
#'   \item cut. quality of the cut (Fair, Good, Very Good, Premium, Ideal)
#'   \item colour. diamond colour, from J (worst) to D (best)
#'   \item clarity. a measurement of how clear the diamond is (I1 (worst), SI1, SI2, VS1, VS2, VVS1, VVS2, IF (best))
#'   \item x. length in mm (0--10.74)
#'   \item y. width in mm (0--58.9)
#'   \item z. depth in mm (0--31.8)
#'   \item depth. total depth percentage = z / mean(x, y) = 2 * z / (x + y) (43--79)
#'   \item table. width of top of diamond relative to widest point (43--95)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name diamonds
#' @usage data(diamonds)
#' @format A data frame with 53940 rows and 10 variables
NULL

Isso resulta em um arquivo de ajuda que se parece com o seguinte: