¿Hay una manera de actualizar automáticamente la documentación en un paquete de R?
Pregunta
utiliza 'package.skeleton ()' para generar archivos de ayuda .rd hace unos meses. He editado estos archivos, y también he cambiado las funciones, eliminado algunas funciones, agregados otros. ¿Hay una función que automatiza la actualización de los archivos Rd?
actualización
Un buen paquete se acaba de publicar llama Rd2roxygen , se es descrito por el autor en su Xie Yihui el blog .
Como su nombre indica, este paquete permite a uno retroactivamente inserto de la documentación contenida en este momento .rd en archivos .R. Suena como un enfoque prometedor para ambos roxygen aprendizaje y para la conversión de los paquetes actualmente en el desarrollo de paquetes R. Woo Hoo. Gracias Yihui!
En base a las respuestas de Joshua y Yihui, la respuesta parece ser: roxygen permite la actualización automática de archivos, etc. Rd basado en los cambios en el código fuente .R, y si no estoy utilizando actualmente roxygen , Rd2roxygen me puede ayudar a migrar.
Solución
Rd2roxygen
fue diseñado para los desarrolladores de paquetes de ayuda que han sido "atrapados" en los archivos Rd primas, pero desea cambiar a roxygen
- que puede procesar archivos Rd y actualizar los scripts R con comentarios roxygen. A partir de entonces, puede comenzar a disfrutar de la potencia de roxygen
. Así Rd2roxygen
no es una respuesta directa, pero que podría ayudar con la transición.
Otros consejos
Esto no responde específicamente a su pregunta, pero puede estar interesado en Roxygen .
No, no lo creo.
Pero usted podría intentar volver a ejecutar package.skeleton()
para las funciones nuevas o modificadas y luego combinar esto con la mano.