Hilfedatei-Dokumentation erzeugen
Nachdem du deine Dokumentation mit roxygen2-Headern erstellt hast, ist der nächste Schritt, sie zu bauen. Das gelingt dir für alle Funktionen im Paket mit der Funktion roxygenize() aus dem Paket roxygen2. Die Dokumentation für jede Funktion wird als eigene Datei (je eine pro Funktion) im Verzeichnis man erzeugt. Sobald dieser Schritt abgeschlossen ist, kannst du auf die Hilfedateien zugreifen und sie zusammen mit deinen anderen Paketen ansehen. So stellst du sicher, dass dein Paket gut dokumentiert und einsatzbereit ist.
Das Paket roxygen2 wurde für dich geladen, ebenso alle Paketdateien bis zu diesem Punkt im Kurs.
Diese Übung ist Teil des Kurses
<Kurs>R-Pakete entwickeln</Kurs>Übungsanweisungen
- Erzeuge die Dokumentation für alle Funktionen im Paket
unitConverter.
Interaktive praktische Übung
Versuche dich an dieser Übung, indem du diesen Beispielcode vervollständigst.
# Generate all function documentation
___