Aan de slagGa gratis aan de slag

Functieresultaat en exporteren

Wanneer je de geretourneerde waarde van een functie documenteert, geef je aan wat gebruikers als output kunnen verwachten: gegevens, een getal, een vector met strings of een ander R-resultaat.

Hoewel het NAMESPACE-bestand verantwoordelijk is voor het aangeven welke functies geëxporteerd worden, maak je dit bestand met roxygen2-tags. Door deze tags te gebruiken, zie je direct bij de documentatie of gebruikers toegang hebben tot een functie. Je markeert een functie voor export in de roxygen2-header. Deze eenvoudige aanpak maakt het duidelijk in de documentatie zelf welke functies beschikbaar zijn voor gebruikers.

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

Cursus bekijken

Oefeninstructies

  • Documenteer de returnwaarde met de volgende beschrijving: "A numeric distance value in the unit specified as `unit_to`."
  • Exporteer de functie.

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