LoslegenKostenlos starten

Dokumentation von Funktionsargumenten

Beim Dokumentieren einer Funktion ist ein entscheidender Aspekt, ihre Argumente zu beschreiben. Mit roxygen2 erreichst du das über den Tag @param, gefolgt vom Argumentnamen und den relevanten Details. In dieser Übung dokumentierst du nur das erste Argument, aber es ist Best Practice, jedes Funktionsargument zu dokumentieren. Überlege dir also, wie du die beiden anderen später dokumentierst.

Diese Übung ist Teil des Kurses

<Kurs>R-Pakete entwickeln</Kurs>
Kurs ansehen

Übungsanweisungen

  • Füge einen geeigneten Tag hinzu, um das erste Argument der Funktion dist_converter() zu dokumentieren, und trage in diesen Tag folgende Angaben ein: A numerical distance value to be converted.

Interaktive praktische Übung

Versuche dich an dieser Übung, indem du diesen Beispielcode vervollständigst.

#' 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 bearbeiten und ausführen