importfrom - r roxygen2 example

Al documentar en Roxygen: ¿Cómo hago una lista detallada en @details?

Question

¿Cuál es la sintaxis apropiada para agregar una lista detallada a roxygen2, por ejemplo, en la sección de detalles? ¿Puedo crear un entorno de lista de látex?

Parece que los saltos de línea son simplemente ignorados, es decir

#'' @details text describing parameter inputs in more detail
#''
#'' parameter 1: stuff
#'' 
#'' parameter 2: stuff

¡Gracias!

Answer 1

Aquí hay un ejemplo de roxygen2 siguiendo la formulación de tu problema.

##''
##'' @details text describing parameter inputs in more detail.
##'' /itemize{
##''  /item{"parameter 1"}{Stuff}
##''  /item{"parameter 2"}{Stuff}
##'' }
##''

Esto le permitirá utilizar el detalle en la sección de detalles. También puedes usarlo en las secciones @param.

Espero que esto ayude.

Answer 2

Desde roxygen2 6.0.0 puede usar markdown directamente en su documentación de R.

#'' @details text describing parameter inputs in more detail.
#'' * parameter 1 stuff
#'' * parameter 2 stuff
#'' @md

Para usar esto, incluya Roxygen: list(markdown = TRUE) en su descripción para activar el markdown para todo el paquete o agregue la etiqueta @md a un solo archivo.