Documenta tus datos
La documentación de datos en el desarrollo de paquetes de R es fundamental porque aporta información esencial sobre los conjuntos de datos incluidos en el paquete. Una buena documentación ayuda a los usuarios a entender la estructura, el contenido y el uso previsto de los datos, de modo que puedan tomar decisiones informadas y aprovechar bien la funcionalidad del paquete.
Recuerda el conjunto de datos distance_data que cargaste en el paquete al principio del curso.
Los paquetes testthat y unitConverter ya están cargados en este punto del desarrollo. Ahora mismo estás trabajando en el archivo R/distance_data.R, creado con use_r("distance_data").
Este ejercicio forma parte del curso
Desarrollo de paquetes en R
Instrucciones del ejercicio
- Actualiza el encabezado para que tenga el título
Distance values and unitsy la descripciónDistance values and corresponding unit (feet, meters, or inches) - Actualiza la entrada
@formataData frame with two columns and 1000 rows. - Cambia la parte de
\describepara incluirvalueyunitcomo\items con la informaciónNumeric distance valueyDistance unit. - Añade una entrada
@examplesque muestre cómo imprimirdistance_datay cierra el archivo con el nombre de los datos en una cadena.
ejercicio interactivo práctico
Prueba este ejercicio completando este código de ejemplo.
# Add header and description
___
___
___
# Update format
___
# Document column names and information
#' \describe{
___
___
#' }
# Add example and string of data name
___
___
___