C'è un modo per aggiornare automaticamente la documentazione in un pacchetto R?
Domanda
ho usato 'package.skeleton ()' per generare file .rd aiuto a pochi mesi fa. Ho modificato questi file, e ho cambiato anche le funzioni, rimosse alcune funzioni, gli altri aggiunti. C'è una funzione che consente di automatizzare l'aggiornamento dei file Rd?
update
Un bel pacchetto è stato appena pubblicato chiamato Rd2roxygen , è è descritta dall'autore Yihui Xie sul suo blog .
Come suggerisce il nome, questo pacchetto permette di retroattivamente inserto documentazione attualmente contenute in .rd in file .R. Suona come un approccio promettente per entrambi roxygen l'apprendimento e per la conversione di pacchetti attualmente in sviluppo per pacchetti R. Woo hoo. Grazie Yihui!
Sulla base delle risposte di Joshua e Yihui, la risposta sembra essere: roxygen permette l'aggiornamento automatico dei file Rd ecc in base alle modifiche nel codice sorgente di .R, e se non sto usando roxygen attualmente , Rd2roxygen può aiutarmi a migrare.
Soluzione
Rd2roxygen
è stato progettato per sviluppatori aiuto dei pacchetti che sono stati "bloccati" nei file Rd prime, ma desidera passare a roxygen
- è in grado di elaborare i file Rd e aggiornare gli script R con commenti roxygen. Da allora in poi, si può cominciare a godere del potere di roxygen
. Quindi Rd2roxygen
non è una risposta diretta, ma potrebbe aiutare con la transizione.
Altri suggerimenti
Questo non specificamente rispondere alla tua domanda, ma si può essere interessati a Roxygen .
No, io non la penso così.
Ma si potrebbe provare rieseguire package.skeleton()
per le funzioni nuove o modificate e quindi unire tutto a mano.