Can Roxygen ignorar las funciones no son de usuario?
Pregunta
Me acabas de empezar a jugar con el paquete roxygen
y no tengo muy feliz con los resultados hasta ahora. Sin embargo, me preguntaba, ¿hay una forma de especificar a roxygen
que debería ignorar ciertas funciones que no son accesibles por el usuario?
En concreto, preferiría no tiene un archivo .Rd
pop-up porque estoy usando el gancho .onLoad()
en mi paquete. Esta función ya está documentada en el paquete base
así que no hay razón para que se re-documento.
Solución
Bueno, finalmente encontró y levantase la lista Roxygen-devel en R-forja para ver cuando este se llevaría a cabo, y que parece estar ya en la versión de Roxygen que está en CRAN. La clave es especificar use.Rd2=TRUE
al llamar roxygenize()
. En este modo, Roxygen se saltará la creación de documentación para las funciones que no están precedidos por los comentarios Roxygen.
Otros consejos
Esto está en su lista de tareas - en la próxima versión, sólo funciona con la documentación roxygen crearán archivos hombre.
Utilice el campo de palabras clave interna ( es decir. @keywords internal
) para eliminar la función de la documentación y hacer que esté disponible sólo para usuarios experimentados.
Fuente:. roxygen2 viñeta