CommencerCommencez gratuitement

Documentation des arguments de fonction

Lors de la documentation d’une fonction, un aspect essentiel est la description de ses arguments. Avec roxygen2, vous pouvez le faire à l’aide de l’étiquette @param, suivie du nom de l’argument et des informations pertinentes. Dans cet exercice, vous ne documenterez que le premier argument, mais il est recommandé de documenter tous les arguments de votre fonction ; pensez donc à la manière de documenter les deux autres par la suite.

Cet exercice fait partie du cours

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

Instructions de l’exercice

  • Ajoutez une étiquette adaptée pour documenter le premier argument de la fonction dist_converter() en y ajoutant les informations suivantes : A numerical distance value to be converted.

Exercice interactif pratique

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

#' Convert between distances
#'
#' Performs the conversion based on specified `unit_from` and `unit_to` values.
#'
# Add appropriate tag and details to document the first argument
___
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