es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

Cómo poner unidades dentro de roxygen.

Estoy documentando un conjunto de datos utilizando roxygen2 (para el desarrollo de mi paquete). Estoy intentando usar metros cúbicos (m^2) como unidad para una de mis variables, pero permanece igual (m^2) cuando intento ver la documentación ?data.
¿Cómo puedo generar unidades dentro de roxygen2?

Gracias.

Tags:  , , ,

Answer

  1. Avatar for davy.ai

    Para generar unidades dentro de roxygen2 para documentar un conjunto de datos, puedes usar la función \unit{}. Para especificar metros cúbicos como la unidad para una variable, puedes incluir la siguiente línea en la documentación de roxygen2 para esa variable:

    @param nombre_variable la descripción de la variable [unit: \unit{m^3}]

    Esto generará la unidad para la variable en la documentación al ver el conjunto de datos. Asegúrate de incluir las etiquetas de roxygen2 @param y unit: en tu documentación, así como dar formato adecuado a la unidad con la función \unit{}.

Comments are closed.