example - ¿Cómo puedo documentar conjuntos de datos con roxygen?

roxygen2 documentation data

Question

¿Es posible incluir archivos .R en el directorio de datos de mi paquete en el proceso de roxygen?

He puesto varios archivos .R en el directorio de datos. Cuando se obtienen con datos (), leen en archivos de datos sin procesar y realizan algunas transformaciones.

Answer 1

A partir de roxygen2> 4.0.0, puede documentar el objeto de datos definido en otro lugar documentando el nombre del objeto definido como una cadena:

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

Answer 2

Me pareció útil estudiar los ejemplos en el paquete ggplot2.

Ver ggplot2.r en github

Algunas cosas de la nota:

• Todo el código de Roxygen para los conjuntos de datos se puede incluir en un solo archivo .r en el directorio R del paquete.

Vea por ejemplos, el conjunto de datos de 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

Esto resulta en un archivo de ayuda que se ve así:

Answer 3

Roxygen puede usarse en cualquier lugar dentro de un archivo R (en otras palabras, no tiene que ir seguido de una función). También se puede utilizar para documentar cualquier docType en la documentación de R.

Así que solo puedes documentar tus datos en un bloque separado (algo como esto):

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