Concevoir une vignette de package R
Ce document est l’ossature de vignette dist_conversion.Rmd créée dans l’exercice précédent. Il contient les parties les plus courantes d’un document R Markdown :
- Un en-tête YAML qui contient des métadonnées
- Un texte explicatif rédigé en Markdown
- Des blocs de code R délimités par
```{r}et```; une syntaxe issue du packageknitr
Pour rédiger la documentation du package unitConverter, il est essentiel de montrer aux utilisateurs plusieurs manières d’exploiter ses fonctionnalités. Les vignettes répondent à cet objectif en présentant des exemples, ainsi que du texte explicatif et des précisions dans un format facile à lire.
Cet exercice fait partie du cours
<cours>Développer des packages R</cours>Instructions de l’exercice
- Créez un titre à la ligne 22 : « Convert feet to meters », sans sous-titres.
- Ajoutez « We can use the package to convert 5 feet into meters as follows. » après le titre, en laissant une ligne vide avant.
- Dans le bloc dist-example, faites l’appel approprié à la fonction
dist_converter()pour réaliser la tâche décrite. - À la fin, affichez le résultat en ligne avec « Five feet is
r dist_resultmeters. »
Exercice interactif pratique
Essayez cet exercice en complétant ce code d’exemple.
{"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"}