lenguaje - Incluir ejemplos de datos en el desarrollo de paquetes R
paquetes de r studio (3)
Estoy ansioso por aprender a incorporar ejemplos de datos como comentarios escritos sobre las funciones, como:
##'' @examples
##'' ## Set working directory...
##'' ## Load data into R session:
##'' data <- system.file("extdata", "data.txt", package="...", sep="/t", header=TRUE, stringsAsFactors = FALSE)
##''
##'' ## For reproducible results:
##'' set.seed(999)
Puse mi archivo "data.txt" en el directorio: / pkg_Name / inst / extdata /. Sin embargo, la comprobación de R CMD indica un error en este paso. Si continúo con la compilación R CMD y la instalación de R CMD, luego de cargar el paquete, no puedo obtener los datos en la sesión R ... ¿Alguien podría decirme qué salió mal? ¿Es esta la forma correcta de incluir ejemplos de datos al final del documento de ayuda de la función?
¡Muchas gracias!
Hadley Wickham tiene un capítulo en su libro "Paquetes R" sobre cómo incorporar datos en un paquete R.
Dirk apunta a la documentación oficial sobre datos en paquetes .
Alternativamente, aquí hay un ejemplo de cómo aprender del paquete ggplot2 para conocer cómo incorporar datos usando archivos rda y roxygen.
Aquí está el directorio de data en el paquete ggplot2 . En este ejemplo, cada archivo de datos se almacena en un archivo rda separado (por ejemplo, generado usando save(foo, file=''foo.rda'') .
Consulte el archivo data.r para ver los comandos de Roxygen para generar los archivos de ayuda de Rmd para los datos: por ejemplo,
#'' 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:
#''
#'' @format A data frame with 53940 rows and 10 variables:
#'' /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 color: 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)
#'' }
"diamonds"
Mire los paquetes CRAN que incluyen datos y copie su enfoque. Acabo de agregar datos a un paquete solo en el trabajo hace unas semanas y simplemente funciona ...
Para lo que vale la pena, el manual tiene una sección 1.1.5 Datos en paquetes que lo explica.
x <- sample(1000)
devtools::use_data(x, mtcars)