LoslegenKostenlos starten

Einstiege für Funktionsdokumentation

Die roxygen2-Header, die im selben Skript wie der Funktionscode enthalten sind, verwenden roxygen2-Kommentare #', um die Kopfzeilen zu kennzeichnen. Die ersten beiden Kommentare (Titel und Beschreibung) haben eine besondere Bedeutung und benötigen keine Tags, müssen jedoch durch eine neue Zeile getrennt werden. Denk daran: Der Titel gibt einen kurzen Überblick über das Ziel der Funktion, während die Beschreibung zusätzliche Informationen und Erläuterungen liefert. Zum Beispiel:

#' My function title
#'
#' Its description

Diese Übung ist Teil des Kurses

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

Übungsanweisungen

  • Füge den Titel "Convert between distances" zu deinem roxygen2-Header hinzu.
  • Füge die folgende kurze Funktionsbeschreibung hinzu: "Performs the conversion based on specified unit_from and unit_to values."

Interaktive praktische Übung

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

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