1. Inicio
  2. Pregunta y respuesta
  3. ¿Puede Roxygen ignorar las funciones que no son del usuario?

¿Puede Roxygen ignorar las funciones que no son del usuario?

2010-02-23 14 views
9

Acabo de empezar a jugar con el paquete roxygen y estoy muy contento con los resultados hasta el momento. Sin embargo, me preguntaba, ¿hay alguna manera de especificar al roxygen que debería ignorar ciertas funciones que no son accesibles para el usuario?¿Puede Roxygen ignorar las funciones que no son del usuario?

Específicamente, prefiero no tener un archivo .Rd emergente porque estoy usando el gancho .onLoad() en mi paquete. Esta función ya está documentada en el paquete base, por lo que no hay motivo para que vuelva a documentarla.

Fuente

2010-02-23 Sharpie

Respuesta

14

Bueno, finalmente encontré y busqué la lista de Roxygen-devel en R-forge para ver cuándo se implementaría esto, y parece que ya está en la versión de Roxygen que está en CRAN. La clave es especificar use.Rd2=TRUE al llamar al roxygenize(). En este modo, Roxygen omitirá la creación de documentación para cualquier función que no esté precedida por los comentarios de Roxygen.

Fuente

2010-02-23 16:57:52 Sharpie

+1

+1 Gracias por dar seguimiento a eso. – Shane

+3

En roxygen2, también puede usar '@ noRd' para suprimir la creación en archivos Rd incluso si tiene documentación de roxygen2. – hadley

2

Esto está en su lista de tareas pendientes: en la próxima versión, solo las funciones con documentación roxygen crearán archivos man.

Fuente

2010-02-23 16:15:19 hadley

Cuestiones relacionadas

 Cuestiones relacionadas