example - roxygen2 insertar manualmente saltos de línea

r roxygen2 example

Question

Tengo una función que estoy tratando de documentar con roxygen2:

#'' Name of function
#''
#'' Description
#''
#'' @param x The input data
#'' @param method one of:
#'' "method1" - very long text here
#'' "method2" - very long text here
#'' "method3" - very long text here
#'' "method4" - very long text here
#'' "method5" - very long text here
#'' "method6" - very long text here
#'' "method7" - very long text here
#'' "method8" - very long text here
#'' "method9" - very long text here
#'' "method10" - very long text here
myfun <- function (x, method){return(NULL)}

Esta función tiene aproximadamente 10 métodos diferentes, cada uno de los cuales tiene una descripción muy larga. Quiero una nueva línea entre cada "método", para que sea más fácil ver rápidamente los diferentes métodos disponibles.

Como está escrito, cuando llamo a roxygenize(''mypackage'') , el texto anterior se aplasta en una sola línea.

¿Cómo inserto manualmente los saltos de línea en la documentación de roxygen2?

Answer 1

Esto funciona:

#'' Name of function
#''
#'' Description
#''
#'' @param x The input data
#'' @param method one of: /cr
#'' "method1" - very long text here /cr
#'' "method2" - very long text here /cr
#'' "method3" - very long text here /cr
#'' "method4" - very long text here /cr
#'' "method5" - very long text here /cr
#'' "method6" - very long text here /cr
#'' "method7" - very long text here /cr
#'' "method8" - very long text here /cr
#'' "method9" - very long text here /cr
#'' "method10" - very long text here /cr
myfun <- function (x, method){return(NULL)}

Aquí hay un ejemplo real en un repositorio donde uso /cr : https://github.com/trinker/SOdemoing/blob/master/R/FUN.R

También el comentario de @Gregor está bien tomado. Eso se vería así:

#'' @param method2 one of:
#'' /itemize{
#'' /item method1 - very long text here
#'' /item method2 - very long text here
#'' /item method3 - very long text here
#'' /item method4 - very long text here
#'' /item method5 - very long text here
#'' /item method6 - very long text here
#'' /item method7 - very long text here
#'' /item method8 - very long text here
#'' /item method9 - very long text here
#'' /item method10 - very long text here
#'' }

Aquí puedes ver la salida de ambos:

Creé un repo de GitHub, SOdemoing , para probar cosas como esta (preguntas y respuestas relacionadas con paquetes más elaborados). Consulte https://github.com/trinker/SOdemoing/blob/master/R/FUN.R donde https://github.com/trinker/SOdemoing/blob/master/R/FUN.R ambos enfoques utilizando roxygen2 y luego el manual de ayuda resultante donde configuro esto (nuevamente, la función es FUN.R).