CommencerCommencez gratuitement

Premiers éléments de documentation de fonction

Les en-têtes roxygen2, placés dans le même script que le code de la fonction, utilisent les commentaires roxygen2 #' pour identifier les lignes d’en-tête. Les deux premiers commentaires (titre et description) ont une signification particulière et ne nécessitent pas de balises, mais doivent être séparés par une ligne vide. Gardez en tête que le titre donne un aperçu succinct de l’objectif de la fonction, tandis que la description apporte des précisions et développe l’explication. Par exemple :

#' Mon titre de fonction
#'
#' Sa description

Cet exercice fait partie du cours

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

Instructions de l’exercice

  • Ajoutez le titre « Convertir entre des distances » à votre en-tête roxygen2.
  • Ajoutez la courte description suivante de la fonction : « Effectue la conversion en fonction des valeurs unit_from et unit_to spécifiées. »

Exercice interactif pratique

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

# Add the title
___
___
# Add the description
___
dist_converter <- function(dist_value, unit_from, unit_to) {
  if (unit_from == "feet" && unit_to == "meters") {
    return(dist_value / 3.28)
  } else if (unit_from == "meters" && unit_to == "feet") {
    return(dist_value * 3.28)
  } else if (unit_from == unit_to) {
    warning("unit_from and unit_to are the same, returning dist_value")
    return(dist_value)
  } else {
    stop("This function only supports conversions between feet and meters.")
  }
}
Modifier et exécuter le code