LoslegenKostenlos starten

Dokumentiere deine Daten

Das Dokumentieren von Daten in der R-Paketentwicklung ist entscheidend, weil es wichtige Informationen über die im Paket enthaltenen Datensätze bereitstellt. Eine gute Dokumentation hilft Nutzerinnen und Nutzern, die Struktur, den Inhalt und den vorgesehenen Einsatz der Daten zu verstehen. So können sie fundierte Entscheidungen treffen und die Funktionen des Pakets effektiv nutzen.

Erinnere dich an den Datensatz distance_data, den du früher im Kurs in das Paket geladen hast.

Die Pakete testthat und unitConverter sind für diesen Entwicklungsstand bereits geladen. Du arbeitest gerade in der Datei R/distance_data.R, die mit use_r("distance_data") erstellt wurde.

Diese Übung ist Teil des Kurses

<Kurs>R-Pakete entwickeln</Kurs>
Kurs ansehen

Übungsanweisungen

  • Aktualisiere die Überschrift mit dem Titel Distance values and units und der Beschreibung Distance values and corresponding unit (feet, meters, or inches).
  • Aktualisiere den Eintrag @format auf Data frame with two columns and 1000 rows.
  • Ändere den Teil \describe, sodass value und unit als \items enthalten sind, mit den Informationen Numeric distance value und Distance unit.
  • Füge einen @examples-Eintrag hinzu, der zeigt, wie distance_data ausgegeben wird, und schließe die Datei mit dem Namen der Daten als String ab.

Interaktive praktische Übung

Versuche dich an dieser Übung, indem du diesen Beispielcode vervollständigst.

# Add header and description
___
___
___
# Update format
___
# Document column names and information
#' \describe{
___
___
#' }
# Add example and string of data name
___
___
___
Code bearbeiten und ausführen