Aan de slagGa gratis aan de slag

Documenteer je data

Het documenteren van data in R-pakketontwikkeling is cruciaal, omdat het essentiële informatie biedt over de gegevenssets die in het pakket zijn opgenomen. Goede documentatie helpt gebruikers de structuur, inhoud en het beoogde gebruik van de data te begrijpen, zodat ze weloverwogen keuzes kunnen maken en de functionaliteit van het pakket effectief kunnen benutten.

Denk terug aan de gegevensset distance_data die je eerder in de cursus aan het pakket hebt toegevoegd.

De pakketten testthat en unitConverter zijn in deze fase van de ontwikkeling al voor je geladen. Je werkt nu in het bestand R/distance_data.R, dat is aangemaakt met use_r("distance_data").

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

Cursus bekijken

Oefeninstructies

  • Werk de kop bij zodat de titel Distance values and units is en de beschrijving Distance values and corresponding unit (feet, meters, or inches)
  • Werk de @format-regel bij naar Data frame with two columns and 1000 rows.
  • Pas het \describe-gedeelte aan zodat value en unit als \items voorkomen, met respectievelijk Numeric distance value en Distance unit als informatie.
  • Voeg een @examples-regel toe die laat zien hoe je distance_data afdrukt en sluit het bestand af met de naam van de data als string.

Praktische interactieve oefening

Probeer deze oefening eens door deze voorbeeldcode in te vullen.

# Add header and description
___
___
___
# Update format
___
# Document column names and information
#' \describe{
___
___
#' }
# Add example and string of data name
___
___
___
Code bewerken en uitvoeren