Ontwerp een R-packagevignet
Dit document is het vignet-sjabloon dist_conversion.Rmd dat in de vorige oefening is gemaakt. Het bevat de meest herkenbare onderdelen van een R Markdown-document:
- Een YAML-header met wat metadata
- Verhalende tekst geschreven in Markdown
- R-codechunks omgeven door
```{r}en```; een syntaxis afkomstig uit hetknitr-pakket
Om pakketdocumentatie voor het unitConverter-pakket te ontwikkelen, is het essentieel om gebruikers veel verschillende manieren te laten zien om met de functionaliteit van het pakket te werken. Vignetten dienen dat doel door zowel voorbeelden te tonen als extra toelichting en verduidelijkingen toe te voegen in een gemakkelijk leesbaar formaat.
Deze oefening maakt deel uit van de cursus
R-pakketten ontwikkelen
Oefeninstructies
- Maak op regel 22 een kop met "Convert feet to meters" zonder subkoppen.
- Voeg na de kop, met één lege regel ertussen, toe: "We can use the package to convert 5 feet into meters as follows.".
- Maak in de dist-example-chunk de juiste aanroep van de functie
dist_converter()om de beschreven taak uit te voeren. - Geef tot slot het resultaat inline weer met "Five feet is
r dist_resultmeters."
Interactieve oefening met praktijkervaring
Probeer deze oefening door deze voorbeeldcode aan te vullen.
{"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"}