Documentazione con roxygen2

Sviluppare pacchetti R

Jasmin Ludolf

Content Developer

Definizione della funzione 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.")
  }
}

Intestazioni roxygen2 di temp_converter() per Titolo e Descrizione

#' Converti tra temperature in Fahrenheit e Celsius
#'

#' `temp_converter()` esegue la conversione in base ai valori di `unit_from` 
#' e `unit_to` indicati. Se le unità non sono valide o 
#' se `unit_from` e `unit_to` coincidono, vengono generati avvisi o errori 
#' appropriati.

temp_converter() Uso e argomenti

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

#' @param value Valore numerico della temperatura da convertire.
#' @param unit_from Stringa dell’unità di partenza 
#'   (predefinita: "Celsius").
#' @param unit_to Stringa dell’unità di arrivo 
#'   (predefinita: "Fahrenheit").

temp_converter() Ritorni, See Also ed export

#' @returns Un valore numerico della temperatura nell’unità indicata in `unit_to`.

See Also non usato per questa funzione

#' @export

Esempi di temp_converter()

#' @examples
#' # Converti 25 gradi Celsius in Fahrenheit 
#' temp_converter(25, unit_from = "Celsius", unit_to = "Fahrenheit")

#' # Converti 100 gradi Fahrenheit in Celsius 
#' temp_converter(100, unit_from = "Fahrenheit", unit_to = "Celsius")

Importanza degli esempi nella documentazione delle funzioni R

Uso pratico

Migliora la comprensione

Invita all’esplorazione

Rafforza l’apprendimento

Una persona davanti a un laptop, mostrata due volte: prima confusa con un punto interrogativo, poi con una lampadina, non più confusa

Documentare con roxygenize()

Aggiorna il file NAMESPACE

library(roxygen2)
roxygenize()

output di roxygenize()

Le export vanno nel file NAMESPACE

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

export(temp_converter)

Utente del pacchetto felice

Passiamo alla pratica!

Sviluppare pacchetti R