Come posso documentare insiemi di dati con roxygen?

Question

E 'possibile includere i file .R nella directory dei dati del mio pacchetto nel processo roxygen?

Ho messo diversi file .R nella directory dei dati. Quando vengono acquistati con i dati (), che leggono i file di dati grezzi e di eseguire alcune trasformazioni.

Answer 1

Roxygen può essere utilizzato ovunque all'interno di un file R (in altre parole, non deve essere seguita da una funzione). Può anche essere usato per documentare qualsiasi docType nella documentazione R.

Quindi, si può solo documentare i vostri dati in un blocco separato (qualcosa di simile):

#' 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 partire dal roxygen2> 4.0.0, è possibile documentare l'oggetto di dati definiti altrove documentando il nome dell'oggetto definito come una stringa:

#' 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

Ho trovato utile per studiare gli esempi nel pacchetto ggplot2.

ggplot2.r su github

Un paio di cose di nota:

• Tutto il codice Roxygen per i set di dati può essere incluso in un unico file nella directory .r R del pacchetto.

Si veda per esempio, il set di dati diamonds:

#' 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

Il risultato è un file di aiuto che assomiglia a questo: