IniziaInizia gratis

Documenta i tuoi dati

Documentare i dati nello sviluppo di un pacchetto R è fondamentale, perché fornisce informazioni essenziali sugli insiemi di dati inclusi nel pacchetto. Una documentazione corretta aiuta l'utente a comprendere struttura, contenuto e uso previsto dei dati, permettendogli di prendere decisioni informate e sfruttare al meglio le funzionalità del pacchetto.

Ricorda il set di dati distance_data che hai caricato nel pacchetto in una lezione precedente.

I pacchetti testthat e unitConverter a questo punto dello sviluppo sono già stati caricati per te. Stai lavorando nel file R/distance_data.R creato con use_r("distance_data").

Questo esercizio fa parte del corso

Sviluppare pacchetti R

Visualizza il corso

Istruzioni dell'esercizio

  • Aggiorna l'intestazione impostando il titolo su Distance values and units e la descrizione su Distance values and corresponding unit (feet, meters, or inches)
  • Aggiorna la voce @format in Data frame with two columns and 1000 rows.
  • Modifica la sezione \describe includendo value e unit come \item con rispettivamente Numeric distance value e Distance unit come informazioni.
  • Aggiungi una voce @examples che mostri come stampare distance_data e chiudi il file con il nome dei dati come stringa.

Esercizio pratico interattivo

Prova a risolvere questo esercizio completando il codice di esempio.

# Add header and description
___
___
___
# Update format
___
# Document column names and information
#' \describe{
___
___
#' }
# Add example and string of data name
___
___
___
Modifica ed esegui il codice