2010-11-04 21 views
7

Usé '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 y agregado otras. ¿Hay alguna función que automatice la actualización de los archivos Rd?¿Hay alguna forma de actualizar automáticamente la documentación en un paquete R?

actualización

Un buen paquete se acaba de publicar llama Rd2roxygen, es descrito por el autor en su Xie Yihui blog.

Como su nombre lo indica, este paquete le permite a uno insertar retroactivamente la documentación actualmente contenida en .Rd en archivos .R. Suena como un enfoque prometedor tanto para aprender roxygen como para convertir paquetes actualmente en desarrollo en paquetes R. Woo hoo. Gracias, Yihui!

Sobre la base de las respuestas de Joshua y Yihui, la respuesta parece ser: roxygen permite la actualización automática de archivos Rd etc basado en los cambios en el código fuente .R, y si no estoy utilizando actualmente roxygen, Rd2roxygen puede ayudar yo migro

Respuesta

10

Rd2roxygen fue diseñado para ayudar a los desarrolladores de paquetes que se han "atascado" en los archivos Rd sin procesar, pero quiere cambiar a roxygen - puede procesar archivos Rd y actualizar los scripts R con comentarios roxygen. A partir de ese momento, puede comenzar a disfrutar del poder de roxygen. Entonces Rd2roxygen no es una respuesta directa, pero podría ayudarte con la transición.

1

No, no lo creo.

Pero puede intentar volver a ejecutar package.skeleton() para funciones nuevas o modificadas y luego combinar esto a mano.

9

Esto no responde específicamente a su pregunta, pero puede estar interesado en Roxygen.

+0

¿Cuáles son las ventajas de roxygen sobre las herramientas descritas en "escritura de extensiones R"? –

+0

Principalmente que crea los archivos .Rd para usted según la información adicional que agrega a los archivos .R de origen. –

+4

@David Una ventaja muy importante es que hace que sea fácil escribir la documentación inmediatamente después de haber escrito el código --- ni siquiera tiene que cambiar de archivos. Entonces, no solo los detalles importantes están frescos en su cabeza, sino que puede escribir los documentos durante el "¡nuevo código de escritura de woohoo!" etapa en lugar de la etapa de producción "ugh ... tiene que volver atrás y documentarlo todo". – Sharpie

Cuestiones relacionadas