Documentatie met roxygen2

R-pakketten ontwikkelen

Jasmin Ludolf

Content Developer

definitie van temp_converter()

temp_converter <- function(value, unit_from = "Celsius", unit_to = "Fahrenheit") {
  if (unit_from == "Celsius" && unit_to == "Fahrenheit") {
    return(value * 9/5 + 32)
  } else if (unit_from == "Fahrenheit" && unit_to == "Celsius") {
    return((value - 32) * 5/9)
  } else if (unit_from == unit_to) {
    warning("unit_from and unit_to are the same, value returned.")
    return(value)
  } else {
    stop("Invalid unit_from or unit_to. Only 'Celsius' and 'Fahrenheit' 
         are accepted.")
  }
}

temp_converter(): roxygen2-koppen voor Title en Description

#' Converteer tussen Fahrenheit- en Celsiustemperaturen
#'

#' `temp_converter()` zet om op basis van `unit_from` 
#' en `unit_to`. Bij ongeldige units of gelijke units 
#' worden passende waarschuwingen of fouten gegeven.

temp_converter(): gebruik en argumenten

temp_converter <- function(value, unit_from = "Celsius", unit_to = "Fahrenheit")

#' @param value Numerieke temperatuurwaarde om te converteren.
#' @param unit_from Tekenreeks van de eenheid om van te converteren 
#'   (standaard: "Celsius").
#' @param unit_to Tekenreeks van de eenheid om naar te converteren 
#'   (standaard: "Fahrenheit").

temp_converter(): returns, See Also en exports

#' @returns Een numerieke temperatuurwaarde in de eenheid van `unit_to`.

See Also overgeslagen voor deze functie

#' @export

temp_converter(): voorbeelden

#' @examples
#' # Zet 25 graden Celsius om naar Fahrenheit 
#' temp_converter(25, unit_from = "Celsius", unit_to = "Fahrenheit")

#' # Zet 100 graden Fahrenheit om naar Celsius 
#' temp_converter(100, unit_from = "Fahrenheit", unit_to = "Celsius")

Belang van voorbeelden in R-functiedocumentatie

Praktisch gebruik

Verbetert begrip

Stimuleert verkenning

Versterkt inzicht

Een persoon voor een laptop, eerst verward met een vraagteken, daarna met een lampje en niet meer verward

Documenteren met roxygenize()

Werk het NAMESPACE-bestand bij

library(roxygen2)
roxygenize()

roxygenize()-output

Exports gaan naar NAMESPACE-bestand

`# Generated by roxygen2: do not edit 
'# by hand

export(temp_converter)

Blije pakketgebruiker

Laten we oefenen!

R-pakketten ontwikkelen