Genera la documentación de archivos de ayuda

Después de crear tu documentación usando cabeceras de roxygen2, el siguiente paso es construirla. Puedes hacerlo para todas las funciones del paquete utilizando la función roxygenize() del paquete roxygen2. La documentación de cada función se generará como archivos independientes (uno por función) en el directorio man. Una vez completado este paso de creación de documentación, podrás acceder a los archivos de ayuda y verlos junto con los de tus otros paquetes. Al seguir este proceso, aseguras que tu paquete esté bien documentado y listo para usar.

El paquete roxygen2 ya se ha cargado por ti, además de todos los archivos del paquete hasta este punto del curso.

Este ejercicio forma parte del curso

Desarrollo de paquetes en R

Instrucciones del ejercicio

Genera la documentación para todas las funciones del paquete unitConverter.

ejercicio interactivo práctico

Prueba este ejercicio completando este código de ejemplo.

# Generate all function documentation
___

Editar y ejecutar código

Este ejercicio forma parte del curso

Desarrollo de paquetes en R

IntermedioNivel de habilidad

4.8+

Empieza el curso gratis

Explora lo esencial de la construcción de paquetes en R: desde la arquitectura y los directorios clave R y man, hasta la importancia de los archivos DESCRIPTION y NAMESPACE. Practica con el paquete usethis para crear el esqueleto de tu propio paquete e incluir datos. Refuerza tus habilidades para escribir funciones en R, comprende las buenas prácticas de desarrollo de paquetes y familiarízate con guardar funciones en un archivo. Por último, instala tu paquete localmente con devtools.

Exercise 1: Componentes de un paquete de R Exercise 2: Verdades sobre los paquetes de R Exercise 3: ¿Qué necesita todo paquete de R?Exercise 4: Componentes obligatorios del paquete Exercise 5: Datos y plantilla de R Markdown en un paquete de R Exercise 6: Crea un paquete de R Exercise 7: Añade datos al paquete de R Exercise 8: Crea un archivo de plantilla R Markdown para un paquete de R Exercise 9: Estructura del archivo de plantilla R Markdown Exercise 10: Crear funciones del paquete Exercise 11: Función de R para convertir distancias Exercise 12: Instala el paquete de R y pruébalo

Conoce las ventajas de crear paquetes frente a usar scripts, y cómo impacta en la organización del código, la reproducibilidad, la colaboración y el intercambio. Descubre estrategias eficaces para estructurar el código y las funciones dentro del directorio R, y cómo elegir un nombre y una licencia adecuados para tu paquete. Para terminar, aprenderás a gestionar las dependencias de paquetes de CRAN.

Exercise 1: Más sobre la estructura de paquetes Exercise 2: Comparar paquetes y scripts Exercise 3: Comprobar el nombre de tu paquete Exercise 4: Elegir una licencia adecuada para tu paquete Exercise 5: Compilación del paquete Exercise 6: Añadir y probar una nueva función en el paquete Exercise 7: Depura errores con load_all()Exercise 8: Diferencias entre errores, advertencias y notas de check()Exercise 9: Dependencias del paquete Exercise 10: Tipos de dependencias de paquetes R Exercise 11: Configurar dependencias del paquete Exercise 12: Establece más dependencias del paquete

Aprovecha el poder de los ejemplos en la documentación creando ejemplos de funciones con roxygen2. Comprende la importancia de los ejemplos para aclarar el comportamiento de una función e identifica los componentes clave de una función de R bien documentada. Explora el propósito de las viñetas en la documentación de paquetes en R y conoce las mejores prácticas para crear viñetas atractivas y evaluar su contenido y calidad mediante el análisis de metadatos.

Exercise 1: Archivos de ayuda con paquetes de R Exercise 2: Orden de los componentes del archivo de ayuda Exercise 3: Funciones exportadas y no exportadas Exercise 4: Documentación con roxygen2 Exercise 5: Inicios de documentación de funciones Exercise 6: Documentación de argumentos de función Exercise 7: Valores devueltos y exportación de funciones Exercise 8: Genera la documentación de archivos de ayuda

Ejercicio actual

Exercise 9: Primeros pasos con las viñetas de paquetes R Exercise 10: Explorar la viñeta del paquete Exercise 11: Propiedades de las viñetas y los artículos Exercise 12: Diseñar viñetas de paquetes de R Exercise 13: Genera el esqueleto de una viñeta de paquete de R Exercise 14: Diseña una viñeta de un paquete de R Exercise 15: Compila las viñetas del paquete

Identifica por qué las pruebas unitarias son importantes para el desarrollo y mantenimiento de paquetes y aprende a implementar el paquete testthat para realizar pruebas unitarias. Convierte ejemplos de R en expectativas para afianzar tus conocimientos sobre pruebas unitarias. Después, verás cómo documentar los datos de tu paquete y ejecutar comprobaciones finales para asegurarte de que has desarrollado un paquete de R robusto.

Exercise 1: Pruebas unitarias Exercise 2: Ventajas de las pruebas unitarias Exercise 3: Prepara tu paquete para realizar pruebas Exercise 4: Crea un archivo de pruebas Exercise 5: Explorando las sentencias expect Exercise 6: Convierte un ejemplo en una prueba Exercise 7: Comprobar avisos y errores Exercise 8: Comprobar salida e identidad Exercise 9: Guardar las expectativas como pruebas unitarias y ejecutar las pruebas Exercise 10: Corrige errores en expectativas Exercise 11: Ejecuta una prueba sobre los ejemplos de la función Exercise 12: Ejecuta todas las pruebas del paquete Exercise 13: Pasos finales Exercise 14: Finaliza tu archivo DESCRIPTION Exercise 15: Documenta tus datos Exercise 16: Comprueba tu paquete de R Exercise 17: ¡Enhorabuena!