Aan de slagGa gratis aan de slag

Documentatie van functieargumenten

Bij het documenteren van een functie is een belangrijk onderdeel de argumenten. Met roxygen2 doe je dit met de tag @param, gevolgd door de argumentnaam en relevante details. In deze oefening documenteer je alleen het eerste argument, maar het is best practice om elk functieargument te documenteren. Denk later dus ook na over hoe je de andere twee documenteert.

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

Cursus bekijken

Oefeninstructies

  • Voeg een passende tag toe om het eerste argument van de functie dist_converter() te documenteren door de volgende details aan deze tag toe te voegen: A numerical distance value to be converted.

Praktische interactieve oefening

Probeer deze oefening eens door deze voorbeeldcode in te vullen.

#' 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.")
  }
}
Code bewerken en uitvoeren