Entwirf eine R-Package-Vignette
Dieses Dokument ist das Vignetten-Skelett dist_conversion.Rmd, das in der letzten Übung erstellt wurde. Es enthält die vertrautesten Teile eines R-Markdown-Dokuments:
- Ein YAML-Header mit einigen Metadaten
- Erklärender Text, geschrieben in Markdown
- R-Code-Chunks, umgeben von
```{r}und```; eine Syntax, die aus demknitr-Paket stammt
Um die Paketdokumentation für das unitConverter-Paket zu entwickeln, ist es entscheidend, den Nutzerinnen und Nutzern viele verschiedene Möglichkeiten zu zeigen, wie sie mit der Funktionalität des Pakets arbeiten können. Vignetten erfüllen diesen Zweck, indem sie sowohl Beispiele zeigen als auch erklärenden Text und Klarstellungen in einem leicht lesbaren Format hinzufügen.
Diese Übung ist Teil des Kurses
<Kurs>R-Pakete entwickeln</Kurs>Übungsanweisungen
- Erstelle in Zeile 22 die Überschrift „Convert feet to meters“ ohne Unterüberschriften.
- Füge nach der Überschrift, mit einer Leerzeile Abstand, „We can use the package to convert 5 feet into meters as follows.“ ein.
- Nimm im Chunk dist-example den passenden Aufruf der Funktion
dist_converter()vor, um die von dir beschriebene Aufgabe zu erfüllen. - Gib am Ende das Ergebnis inline aus mit „Five feet is
r dist_resultmeters.“
Interaktive praktische Übung
Versuche dich an dieser Übung, indem du diesen Beispielcode vervollständigst.
{"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"}