• 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

Incluir tutoriales: creación de viñetas (Creación de paquetes en R 7ª parte)

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

La semana pasada hemos visto cómo crear la documentación de nuestros paquetes de R mediante el uso de roxygen2. Documentación que es imprescindible a la hora de trabajar con cualquier librería. Pero, en la mayoría de los casos lo que realmente buscan los usuarios a la hora de empezar a usar un paquete nuevo es un tutorial con ejemplos en los que se enseñan algunos usos prácticos del software. En los paquetes de R estos tutoriales se denominan “viñetas” (vignettes), siendo la creación de viñetas el tema que trataremos esta semana.

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

Inclusión de viñetas

Posiblemente la inclusión de una viñeta en un paquete R la una de las tareas más sencilla a la hora de crear un paquete, solamente se tiene que incluir el documento. Aunque una de las tareas más complicadas posiblemente sea la escritura del documento. Las viñetas se pueden escribir en LaTeX (para lo que se puede usar Sweave o knitr), pero es mucho más fácil usar R Markdown.

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

R Markdown

Markdown es un lenguaje de marcado ligero que mediante el uso de asteriscos u otros símbolos permiten dar una estructura en archivos de texto plano. Lo que hace que sea altamente portable. Por ejemplo, es el lenguaje de marcado que se usa en los documentos de Jupyter Notebook para incluir celdas con comentarios. R Markdown es una extensión de Markdown en el que se puede incluir fragmentos de código R. Los documentos de R Markdown se pueden transformar, mediante knitr, en documento de Markdown, reemplazando el código R con sus resultados. Para, posteriormente, convertir estos en archivos HTML u otros formatos para su lectura. Aunque los documentos Markdown también se pueden leer directamente sin problemas.

Creación de viñetas con R Markdown

Para incluir una viñeta en formato R Markdown dentro de nuestro paquete R solamente se tiene crear una carpeta vignettes en nuestro proyecto e incluir en ella los archivos R Markdown con extensión Rmd. Archivo que se puede crear directamente desde el menú de Rstudio.

En este archivo es importante que se incluya un encabezado YAML como el que se muestra a continuación:

---
title: "Creación de un vignette de ejempo"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Creación de un vignette de ejempo}
  %\VignetteEngine{knitr::rmarkdown}
  \usepackage[utf8]{inputenc}
---

En este documento vamos a crear un vignette de ejemplo para mostrar como incluir este tipo de documentación en nuestro paquete. Para lo que se utiliza un archivo con la sintaxis de `rmarkdown`.

## Código de ejemplo

En nuestro documento podemos incluir código de ejemplo simplemente empleando tres comillas sencillas invertidas. Por ejemplo, se puede mostrar como sumar dos números con la función suma:

```{r}
library(rlane)
suma(1,2)
```

Como se puede ver en el ejemplo es necesario indicar el título del paquete, el formato de salida y las indicaciones para que se compile. En nuestro caso el formato de salida es HTML que es uno de los más populares.

Además de esto es necesario incluir la recomendación de los paquetes knitr rmarkdown en el archivo DESCRIPTION y una línea en la que se indique cómo crear las viñetas

VignetteBuilder: knitr

Creación de las viñetas

Posiblemente la manera más sencilla de complilaas viñetas sea con la función build_vignettes del paquete devtools. Es decir, escribiendo el comando

devtools::build_vignettes()

Lo que creará los archivos HTML con las viñetas en la carpeta inst/doc.

Conclusiones

En esta entrada hemos visto cómo incluir tutoriales en nuestros paquetes R con la inclusión de viñetas. Los tutoriales son clave para que los usuarios que tiene un primer contacto con nuestro paquete puedan empezar a trabajar de forma eficiente. Sin tener que buscar el toda la documentación los pasos a seguir para llegar a un resultado. La próxima semana finalizamos la serie con una entrada en las que explicaremos los medios que tenemos para distribuir el paquete.

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
  • Guía Completa para Usar el Panda Planner: Tu Camino hacia la Productividad y el Bienestar

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

Guía Completa para Usar el Panda Planner: Tu Camino hacia la Productividad y el Bienestar

noviembre 19, 2026 Por Daniel Rodríguez

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

Publicidad

Es tendencia

  • Guía Completa para Usar el Panda Planner: Tu Camino hacia la Productividad y el Bienestar publicado el noviembre 19, 2026 | en Productividad
  • Cómo comparar datos con barras en Matplotlib: agrupadas, apiladas y porcentuales publicado el mayo 12, 2026 | 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
  • Instantáneas de VirtualBox (Snapshots) publicado el marzo 27, 2019 | en Herramientas
  • Copiar y pegar Activar copiar y pegar en VirtualBox publicado el mayo 1, 2019 | 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