CommencerCommencez gratuitement

Valeurs de retour et export d’une fonction

Lorsque vous documentez la valeur de retour d’une fonction, vous indiquez aux utilisateurs ce qu’ils peuvent attendre en sortie de la fonction, qu’il s’agisse de données, d’un nombre, d’un vecteur de chaînes ou de tout autre résultat R.

Bien que le fichier NAMESPACE identifie les fonctions exportées, vous le générez à l’aide des étiquettes roxygen2. En utilisant ces étiquettes, vous pouvez facilement savoir si les utilisateurs auront accès à une fonction directement depuis sa documentation. Vous marquez une fonction pour l’export dans l’en-tête roxygen2. Cette approche simple vous permet d’indiquer clairement, dans la documentation, quelles fonctions sont à la disposition des utilisateurs.

Cet exercice fait partie du cours

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

Instructions de l’exercice

  • Documentez la valeur de retour avec la description suivante : "A numeric distance value in the unit specified as `unit_to`."
  • Exportez la fonction.

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.
#'
#' @param dist_value A numerical distance value to be converted.
#' @param unit_from A character string of the distance unit to convert from 
#' @param unit_to A character string of the distance unit to convert to
# Add returning value description and tag
___
# Export this function
___
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