EmpezarEmpieza gratis

Valores devueltos y exportación de funciones

Al documentar el valor de retorno de una función, indicas qué pueden esperar los usuarios como salida de la función, ya sea un conjunto de datos, un número, un vector de cadenas u otro resultado de R.

Aunque el archivo NAMESPACE es el responsable de identificar las funciones exportadas, creas este archivo usando etiquetas de roxygen2. Al usar estas etiquetas, puedes determinar fácilmente si los usuarios tendrán acceso a una función justo junto a su documentación. Marcas una función para exportación en el encabezado de roxygen2. Este enfoque directo te permite indicar con claridad qué funciones están disponibles para que los usuarios trabajen con ellas en la propia documentación.

Este ejercicio forma parte del curso

Desarrollo de paquetes en R

Ver curso

Instrucciones del ejercicio

  • Documenta el valor de retorno con la siguiente descripción: "A numeric distance value in the unit specified as `unit_to`."
  • Exporta la función.

ejercicio interactivo práctico

Prueba este ejercicio completando este código de ejemplo.

#' 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.")
  }
}
Editar y ejecutar código