Documentation avec roxygen2

Développer des packages R

Jasmin Ludolf

Content Developer

Définition de la fonction 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.")
  }
}

En-têtes roxygen2 pour le titre et la description de temp_converter()

#' Convertir entre températures Fahrenheit et Celsius
#'

#' `temp_converter()` effectue la conversion selon les valeurs `unit_from` 
#' et `unit_to` fournies. Si la conversion est impossible à cause d'unités non valides
#' ou si `unit_from` et `unit_to` sont identiques, des avertissements ou erreurs
#' appropriés sont générés.

Utilisation et arguments de temp_converter()

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

#' @param value Valeur numérique de la température à convertir.
#' @param unit_from Chaîne de caractères indiquant l'unité source 
#'   (par défaut "Celsius").
#' @param unit_to Chaîne de caractères indiquant l'unité cible 
#'   (par défaut "Fahrenheit").

Valeur de retour, « See Also » et export de temp_converter()

#' @returns Une valeur numérique de température dans l'unité indiquée par `unit_to`.

« See Also » ignoré pour cette fonction

#' @export

Exemples pour temp_converter()

#' @examples
#' # Convertir 25 degrés Celsius en Fahrenheit 
#' temp_converter(25, unit_from = "Celsius", unit_to = "Fahrenheit")

#' # Convertir 100 degrés Fahrenheit en Celsius 
#' temp_converter(100, unit_from = "Fahrenheit", unit_to = "Celsius")

Importance des exemples dans la documentation des fonctions R

Usage concret

Améliore la compréhension

Encourage l'exploration

Renforce les acquis

Une personne devant un ordinateur, montrée deux fois : d'abord perplexe avec un point d'interrogation, puis avec une ampoule, non plus perplexe

Documenter avec roxygenize()

Mettre à jour le fichier NAMESPACE

library(roxygen2)
roxygenize()

sortie de roxygenize()

Les exports vont dans le fichier NAMESPACE

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

export(temp_converter)

Utilisateur de package satisfait

Passons à la pratique !

Développer des packages R