IniziaInizia gratis

Valori di ritorno delle funzioni ed esportazione

Quando documenti il valore restituito di una funzione, specifichi cosa gli utenti possono aspettarsi come output della funzione, che si tratti di dati, di un numero, di un vettore di stringhe o di qualsiasi altro risultato R.

Sebbene il file NAMESPACE sia responsabile dell'identificazione delle funzioni esportate, questo file viene creato usando i tag di roxygen2. Usando questi tag, puoi capire facilmente se gli utenti avranno accesso a una funzione direttamente accanto alla sua documentazione. Contrassegni una funzione per l’esportazione nell’intestazione roxygen2. Questo approccio semplice ti permette di indicare chiaramente, nella documentazione stessa, quali funzioni sono a disposizione degli utenti.

Questo esercizio fa parte del corso

Sviluppare pacchetti R

Visualizza il corso

Istruzioni dell'esercizio

  • Documenta il valore di ritorno con la seguente descrizione: "A numeric distance value in the unit specified as `unit_to`."
  • Esporta la funzione.

Esercizio pratico interattivo

Prova a risolvere questo esercizio completando il codice di esempio.

#' Convert between distances
#'
#' Performs the conversion based on specified `unit_from` and `unit_to` values.
#'
#' @param dist_value A numerical distance value to be converted.
#' @param unit_from A character string of the distance unit to convert from 
#' @param unit_to A character string of the distance unit to convert to
# Add returning value description and tag
___
# Export this function
___
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.")
  }
}
Modifica ed esegui il codice