Aan de slagGa gratis aan de slag

Starters voor functiedocumentatie

De roxygen2-headers, die in hetzelfde script staan als de functiecode, gebruiken roxygen2-comments #' om de kopregels te markeren. De eerste twee comments (titel en beschrijving) hebben een speciale betekenis en vereisen geen tags, maar moeten wel worden gescheiden door een lege regel. Houd er rekening mee dat de titel een korte samenvatting geeft van het doel van de functie, terwijl de beschrijving extra informatie en toelichting biedt. Bijvoorbeeld:

#' Mijn functietitel
#'
#' De beschrijving

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

Cursus bekijken

Oefeninstructies

  • Voeg de titel "Convert between distances" toe aan je roxygen2-header.
  • Voeg de volgende korte beschrijving van de functie toe: "Performs the conversion based on specified unit_from and unit_to values."

Praktische interactieve oefening

Probeer deze oefening eens door deze voorbeeldcode in te vullen.

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