• Saltar al contenido principal
  • Skip to secondary menu
  • Saltar a la barra lateral principal
  • Saltar al pie de página
  • Inicio
  • Secciones
    • Ciencia de datos
    • Criptografía
    • Herramientas
    • Machine Learning
    • Noticias
    • Opinión
    • Productividad
    • Programación
      • JavaScript
      • Julia
      • Matlab
      • Python
      • R
  • Programación
    • JavaScript
    • Julia
    • Matlab
    • Python
    • R
  • Laboratorio
    • Estadística
      • Calculadora del Tamaño Muestral en Encuestas
      • Calculadora de estadísticos descriptivos
      • Test de normalidad
      • Calculadora de contrastes de hipotesis
      • Calculadora de tamano del efecto
      • Simulador de Regresión Lineal con Ruido
      • Descenso de gradiente
      • Visualizador de PCA
      • Visualizador de Series Temporales
      • Simulador de Regresión Logística
      • Matriz de confusión e informe de clasificación
      • Visualizador de fronteras de decisión
      • Simulador de K-Means
      • Número Óptimo de Clusters
      • Simulador de DBSCAN
      • Detector de la Ley de Benford
      • Ajuste de Curvas
      • Calculadora de Matrices
    • Probabilidad
      • Calculadora de Probabilidad de Distribuciones
      • Problema del cumpleaños
      • Calculadora de Probabilidades de Lotería
      • Simulador del Problema de Monty Hall
      • La aguja de Buffon
      • Simulador de la Estrategia Martingala
      • Simulador de Cadenas de Markov
    • Finanzas
      • Calculadora de Préstamos e Hipotecas
      • Conversor TIN ↔ TAE
      • Calculadora DCA con ajuste por inflación
      • Comparador de tarifas de luz 2.0TD
      • Calculadora XIRR con Flujos Irregulares
      • Simulador FIRE (Financial Independence, Retire Early)
      • Frontera Eficiente
    • Negocios
      • CLV
      • Scoring
    • Herramientas
      • Formateador / Minificador de JSON
      • Conversor CSV ↔ JSON
      • Consultar CSV con SQL en el navegador
      • Extractor de tickets (OCR)
      • Comparador y Formateador de Texto y JSON
      • Formateador y Tester de Expresiones Regulares
      • Inspector de JWT
      • Generador y verificador de hashes
      • Calculadora HMAC
      • Codificador / Decodificador Base64 y URL
      • Conversor de bases numericas
      • Conversor de Timestamp Unix
      • Conversor de colores
      • Generador de UUIDs
      • Editor de expresiones cron
      • Conversor de unidades
    • Juegos
      • Tres en Raya
      • Nim con Q-Learning
    • Más
      • Método D’Hondt
      • Generador de Contraseñas Seguras
  • Noticias
  • Boletín
  • Contacto
  • Tienda
    • Libros
    • Equipamiento de oficina
    • Equipamiento en movilidad

Analytics Lane

Ciencia e ingeniería de datos aplicada

  • Ciencia de datos
  • Machine Learning
  • IA Generativa
  • Python
  • Pandas
  • NumPy
  • R
  • Excel

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

mayo 29, 2020 Por Daniel Rodríguez Deja un comentario
Tiempo de lectura: 3 minutos

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:

Shallow copy vs Deep copy en Python: la mutación inesperada
En Analytics Lane
Shallow copy vs Deep copy en Python: la mutación inesperada

  • @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?

Publicaciones relacionadas

  • Shallow copy vs Deep copy en Python: la mutación inesperada
  • Cómo Proyectar Cuándo Alcanzarás la Independencia Financiera
  • Analytics Lane lanza la versión 1.5 del laboratorio con un extractor de tickets por OCR y consultas SQL sobre CSV en el navegador
  • Cómo Saber si una Diferencia Significativa es Importante
  • Curiosidad: “Wi-Fi” no significa “Wireless Fidelity”
  • Cómo Explorar un Dataset antes de Modelar
  • Cómo Elegir el Test de Hipótesis Correcto para tus Datos
  • Tuplas vs Listas en Python: parecen lo mismo, pero no
  • == vs is en Python: la diferencia que causa bugs misteriosos

Publicidad

Publicado 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.

Barra lateral principal

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

Analytics Lane en redes sociales

  • Amazon
  • Bluesky
  • Facebook
  • GitHub
  • Instagram
  • Mastodon
  • Pinterest
  • RSS
  • Telegram
  • Tumblr
  • Twitter
  • YouTube

Publicidad

Entradas recientes

Noticias

Analytics Lane lanza la versión 1.5 del laboratorio con un extractor de tickets por OCR y consultas SQL sobre CSV en el navegador

noviembre 18, 2026 Por Daniel Rodríguez

Cómo Explorar un Dataset antes de Modelar

noviembre 17, 2026 Por Daniel Rodríguez

Curiosidad: “Wi-Fi” no significa “Wireless Fidelity”

noviembre 12, 2026 Por Daniel Rodríguez

Publicidad

Es tendencia

  • Cómo Explorar un Dataset antes de Modelar publicado el noviembre 17, 2026 | en Ciencia de datos
  • Gráficos de barras en Matplotlib publicado el julio 5, 2022 | en Python
  • Operaciones de filtrado de DataFrame con Pandas en base a los valores de las columnas publicado el mayo 10, 2019 | en Python
  • Hoja de cálculo para repartir los escaños en base al método D’Hont Aplicar el método D’Hondt en Excel publicado el abril 14, 2021 | en Herramientas
  • La tabla de la web finalmente importada en Excel Importar tablas desde la web en Excel publicado el octubre 21, 2020 | en Herramientas

Publicidad

Lo mejor valorado

4.9 (24)

Seleccionar filas y columnas en Pandas con iloc y loc

4.6 (16)

Archivos JSON con Python: lectura y escritura

4.4 (14)

Ordenación de diccionarios en Python mediante clave o valor

4.7 (13)

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

4.1 (11)

Aplicar el método D’Hondt en Excel

Comentarios recientes

  • Daniel Rodríguez en Curiosidad: La Paradoja de Simpson, o por qué no siempre debes fiarte de los promedios
  • Hatepi en Curiosidad: La Paradoja de Simpson, o por qué no siempre debes fiarte de los promedios
  • Daniel Rodríguez en Los récords con asterisco, o la épica del titular sin contexto – El bestiario de los indicadores económicos absurdos (parte 8 y final)
  • Juan en Los récords con asterisco, o la épica del titular sin contexto – El bestiario de los indicadores económicos absurdos (parte 8 y final)
  • bif en JSON en bases de datos: cuándo es buena idea y cuándo no

Publicidad


Footer

Analytics Lane

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

Secciones

  • Ciencia de datos
  • Criptografía
  • Herramientas
  • Machine Learning
  • Opinión
  • Productividad
  • Programación
  • Reseñas

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.

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