• Ir al contenido principal
  • Skip to secondary menu
  • Ir a la barra lateral primaria
  • Ir al pie de página
  • Inicio
  • Secciones
    • Ciencia de datos
    • Criptografía
    • Herramientas
    • Noticias
    • Opinión
  • Programación
    • JavaScript
    • Julia
    • Matlab
    • Python
    • R
  • Boletín
  • Contacto
  • Acerca de Analytics Lane
  • Tienda
    • Libros
    • Equipamiento de oficina
    • Equipamiento en movilidad
    • Tiendas afiliadas
      • AliExpress
      • Amazon
      • GearBest
      • GeekBuying
      • JoyBuy

Analytics Lane

Ciencia e ingeniería de datos aplicada

  • Ciencia de datos
  • Criptografía
  • Python
  • Matlab
  • R
  • Julia
  • JavaScript
  • Herramientas
  • Opinión
  • Noticias

Documentación de los paquetes (Creación de paquetes en R 6ª parte)

mayo 29, 2020 Por Daniel Rodríguez Dejar un comentario

La documentación de los paquetes es una tarea clave, ya que es la forma de explicar a los usuarios cómo utilizar las funciones y cual es la respuesta que se puede esperar. En un paquete de R la documentación de las funciones se incluye en los archivos Rd que se encuentra dentro de la carpeta man. Siendo esta la información que verán los usuarios cuando consulten la ayuda de las funciones. Para facilitar el mantenimiento de la documentación es una buena práctica escribir la documentación junto al código. Algo que se puede hacer con la ayuda del paquete roxygen2. Un paquete que trasforma los comentarios de las funciones función en formato de documentación estándar de R.

Esta entrada forma parte de la serie “Creación de paquetes en R” cuyo código se puede encontrar en el repositorio y consta de las siguientes ocho entradas:

  1. Creación de paquetes en R
  2. El archivo DESCRIPTION
  3. Pruebas automáticas con testthat
  4. Pruebas avanzadas con testthat
  5. Medir la cobertura de las automáticas unitarias
  6. Documentación de los paquetes
  7. Creación de vignette
  8. Validación y distribución de los paquetes

Instalación de roxygen2

Antes poder utilizar el paquete roxygen2 es necesario instalarlo, para lo que recurriremos como siempre al comando install.packages

install.packages("roxygen2")

Documentación de una función

Una vez instalado el paquete podemos comenzar a incluir la documentación del paquete. Para abriremos al archivo suma.R y, antes de la función suma(), podemos escribir comentarios que comiencen por #', lo que indica a roxygen2 que estos son los comentarios que debe procesar.
Además de esto existen comandos para indicar a roxygen2 información especial sobre la función como los parámetros de entrada, los datos de salida o ejemplos de código. Así los comandos más habituales son:

  • @param: después de este comando se escribe el nombre de un parámetro de entrada y una pequeña descripción de lo que la función espera en el mismo. Se tiene que crear una linea para cada uno de los parámetros de la función.
  • @return: con este comando se indica que incluye la respuesta de la función
  • @examples: a partir de este comando se puede incluir código R valido como a modo de ejemplo de uso.
  • @seealso: si la función está relacionada con otras aquí se indica esas otras funciones que el usuario puede consultar para tener más información.
  • @export: al escribir esta line se le indica a roxygen2 que agregue esta función al archivo NAMESPACE para que sea accesible para los usuarios. Lo más habitual es incluir esta opción en todas las funciones que se escriben en el paquete, ya que sino serán únicamente accesibles desde el interior del paquete.

Ejemplo de la función suma()

Por ejemplo, esta es la documentación que podemos incluir en para la función suma().

#' Suma dos números
#'
#' @param a un número
#' @param b un número
#'
#' @return La suma de \code{a} y \code{b}
#'
#' @examples
#' suma(1, 1)
#'
#' @export
suma <- function(a,b) {
  return(a + b)
}

Documentación del paquete

Además de para crear la documentación de las funciones también se puede usar roxygen2 para la de los paquetes. En este caso se escribirá la documentación como la de una función, pero en lugar de antes de una función se escribirá antes de una línea con la instrucción "_PACKAGE". Así la documentación de nuestro paquete puede ser simplemente:

#' Plantilla de Paquete R
#'
#' Esta es un paquete de ejemplo creado para el tutorial de Analytics Lane
#'
"_PACKAGE"

Creación de la documentación

Antes de crear la documentación es necesario borrar el archivo NAMESPACE que había creado el asistente de RStudio. Este archivo exporta todas las funciones del paquete y si no se elimina roxygen2 no lo sobrescribirá. Una vez eliminado este archivo solamente se tiene que escribir el comando devtools::document() para crear la documentación.

Conclusiones

En esta entrega hemos visto como con la ayuda del paquete roxygen2 documentar las funciones de R se vuelve extremadamente sencillo y fácil de mantener. Ya que podemos incluir la documentación en los comentarios para que el paquete se encargue de generar los archivos correspondientes. La semana que viene veremos cómo incluir tutoriales en nuestros paquete con la ayuda de R Markdown.

Imagen de Peter H en Pixabay

¿Te ha parecido de utilidad el contenido?

¡Puntúalo entre una y cinco estrellas!

Puntuación promedio 0 / 5. Votos emitidos: 0

Ya que has encontrado útil este contenido...

¡Síguenos en redes sociales!

¡Siento que este contenido no te haya sido útil!

¡Déjame mejorar este contenido!

Dime, ¿cómo puedo mejorar este contenido?

Contenido relacionado

Archivado en:R

Interacciones con los lectores

Deja una respuesta Cancelar la respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

I accept the Terms and Conditions and the Privacy Policy

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.

Publicidad


Barra lateral primaria

Suscríbete a nuestro boletín

Suscríbete al boletín semanal para estar al día de todas las publicaciones.

Política de Privacidad

¡Síguenos en redes sociales!

  • facebook
  • github
  • telegram
  • pinterest
  • rss
  • tumblr
  • twitter
  • youtube

Publicidad

Tiendas afiliadas

Ayúdanos realizando tus compras sin coste adicional con los enlaces de la tienda. ¡Gracias!

Entradas recientes

Creación de un certificado Let’s Encrypt en Windows con Win-Acme

enero 22, 2021 Por Daniel Rodríguez Dejar un comentario

Aplicaciones de Node en producción con PM2

enero 20, 2021 Por Daniel Rodríguez Dejar un comentario

SQLite en Python

enero 18, 2021 Por Daniel Rodríguez Dejar un comentario

Publicidad

Es tendencia

  • Seleccionar filas y columnas en Pandas con iloc y loc bajo Python
  • Unir y combinar dataframes con pandas en Python bajo Python
  • Excel en Python Guardar y leer archivos Excel en Python bajo Python
  • ¿Cómo eliminar columnas y filas en un dataframe pandas? bajo Python
  • Operaciones de filtrado de DataFrame con Pandas en base a los valores de las columnas bajo Python

Publicidad

Lo mejor valorado

5 (3)

Ordenar una matriz en Matlab en base a una fila o columna

5 (3)

Automatizar el análisis de datos con Pandas-Profiling

5 (5)

Diferencias entre var y let en JavaScript

5 (6)

Operaciones de filtrado de DataFrame con Pandas en base a los valores de las columnas

5 (3)

Unir y combinar dataframes con pandas en Python

Publicidad

Comentarios recientes

  • Daniel Rodríguez en Calculadora de probabilidades de ganar a la lotería
  • abel en Calculadora de probabilidades de ganar a la lotería
  • David Arias en Diferencias entre regresión y clasificación en aprendizaje automático
  • Juan Aguilar en Archivos JSON con Python: lectura y escritura
  • Camilo en Contar palabras en una celda Excel

Publicidad

Footer

Secciones

  • Ciencia de datos
  • Criptografía
  • Herramientas
  • Noticias
  • Opinión

Programación

  • JavaScript
  • Julia
  • Matlab
  • Python
  • R

Analytics Lane

  • Acerca de Analytics Lane
  • Boletín de noticias
  • Contacto
  • Lo más popular
  • Tienda

Tiendas Afiliadas

  • AliExpress
  • Amazon
  • BangGood
  • GearBest
  • Geekbuying
  • JoyBuy

Sobre de Analytics Lane

En Analytics Lane tratamos de explicar los principales conceptos de la ciencia e ingeniería de datos con un enfoque práctico. Los principales temas tratados son ciencia de datos, ingeniería de datos, inteligencia artificial, machine learning, deep learning y criptografía. Además, también se habla de los principales lenguajes de programación y herramientas utilizadas por los científicos e ingenieros de datos.

Tiendas afiliadas

Ayúdanos realizando tus compras sin coste adicional con los enlaces de la tienda. ¡Gracias!

Amazon

2018-2020 Analytics Lane · Términos y condiciones · Política de Cookies · Política de Privacidad · Herramientas de privacidad · Contacto