EmpezarEmpieza gratis

Documentación de argumentos de función

Al documentar una función, uno de los aspectos clave es describir sus argumentos. Con roxygen2, puedes hacerlo usando la etiqueta @param, seguida del nombre del argumento y los detalles relevantes. En este ejercicio solo documentarás el primer argumento, pero lo ideal es documentar todos los argumentos de tu función, así que piensa más adelante cómo documentar los otros dos.

Este ejercicio forma parte del curso

Desarrollo de paquetes en R

Ver curso

Instrucciones del ejercicio

  • Añade una etiqueta adecuada para documentar el primer argumento de la función dist_converter() incluyendo en esa etiqueta el siguiente detalle: A numerical distance value to be converted.

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.
#'
# Add appropriate tag and details to document the first argument
___
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