EmpezarEmpieza gratis

Inicios de documentación de funciones

Los encabezados de roxygen2, incluidos en el mismo script que el código de la función, usan los comentarios de roxygen2 #' para identificar las líneas del encabezado. Los dos primeros comentarios (título y descripción) tienen un significado especial y no requieren etiquetas, pero deben separarse por una línea en blanco. Ten en cuenta que el título ofrece un resumen breve del objetivo de la función, mientras que la descripción aporta información adicional y la desarrolla. Por ejemplo:

#' My function title
#'
#' Its description

Este ejercicio forma parte del curso

Desarrollo de paquetes en R

Ver curso

Instrucciones del ejercicio

  • Añade el título "Convert between distances" a tu encabezado de roxygen2.
  • Añade la siguiente descripción breve de la función: "Performs the conversion based on specified unit_from and unit_to values."

ejercicio interactivo práctico

Prueba este ejercicio completando este código de ejemplo.

# Add the title
___
___
# Add the description
___
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