Diseña una viñeta de un paquete de R
Este documento es el esqueleto de la viñeta dist_conversion.Rmd creado en el ejercicio anterior. Incluye las partes más conocidas de un documento R Markdown:
- Un encabezado YAML que contiene metadatos
- Texto narrativo escrito en Markdown
- Bloques de código R delimitados por
```{r}y```; una sintaxis que proviene del paqueteknitr
Para desarrollar la documentación del paquete unitConverter, es fundamental mostrar a las personas usuarias varias formas de trabajar con la funcionalidad del paquete. Las viñetas cumplen ese propósito mostrando ejemplos y añadiendo texto explicativo y aclaraciones en un formato fácil de leer.
Este ejercicio forma parte del curso
Desarrollo de paquetes en R
Instrucciones del ejercicio
- Crea un encabezado en la línea 22 con "Convert feet to meters" sin subencabezados.
- Añade "We can use the package to convert 5 feet into meters as follows." después del encabezado, dejando una línea en blanco.
- En el chunk dist-example, haz la llamada adecuada a la función
dist_converter()para lograr la tarea que has descrito. - Al final, muestra el resultado inline con "Five feet is
r dist_resultmeters."
ejercicio interactivo práctico
Prueba este ejercicio completando este código de ejemplo.
{"dist_conversion.Rmd":"___\ntitle: \"Distance Conversion Examples\"\noutput: rmarkdown::html_vignette\nvignette: >\n %\\VignetteIndexEntry{Distance Conversion Examples}\n %\\VignetteEngine{knitr::rmarkdown}\n %\\VignetteEncoding{UTF-8}\n___\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n collapse = TRUE,\n comment = \"#>\"\n)\n```\n\n```{r setup}\nlibrary(unitConverter)\n```\n\n\n\n\n\n```{r dist-example}\ndist_result <- \n```\n\n\n"}