CommencerCommencez gratuitement

Documenter vos données

La documentation des données dans le développement de packages R est essentielle, car elle fournit des informations clés sur les jeux de données inclus dans le package. Une documentation soignée aide les utilisateurs à comprendre la structure, le contenu et l’usage prévu des données, afin de prendre des décisions éclairées et d’exploiter au mieux les fonctionnalités du package.

Rappelez-vous le jeu de données distance_data que vous avez chargé dans le package plus tôt dans le cours.

Les packages testthat et unitConverter ont été chargés pour vous à ce stade du développement. Vous travaillez actuellement dans le fichier R/distance_data.R qui a été créé avec use_r("distance_data").

Cet exercice fait partie du cours

<cours>Développer des packages R</cours>
Voir le cours

Instructions de l’exercice

  • Mettez à jour l’en-tête avec le titre Distance values and units et la description Distance values and corresponding unit (feet, meters, or inches)
  • Modifiez l’entrée @format pour Data frame with two columns and 1000 rows.
  • Changez la section \describe pour inclure value et unit en tant que \items avec respectivement Numeric distance value et Distance unit comme informations.
  • Ajoutez une entrée @examples montrant comment afficher distance_data et terminez le fichier par le nom des données dans une chaîne de caractères.

Exercice interactif pratique

Essayez cet exercice en complétant ce code d’exemple.

# Add header and description
___
___
___
# Update format
___
# Document column names and information
#' \describe{
___
___
#' }
# Add example and string of data name
___
___
___
Modifier et exécuter le code