2010-02-23 1 views
9

Ho appena iniziato a giocare con il pacchetto roxygen e sono molto soddisfatto dei risultati finora. Tuttavia, mi stavo chiedendo, c'è un modo per specificare a roxygen che dovrebbe ignorare determinate funzioni che non sono accessibili all'utente?Can Roxygen ignora le funzioni non utente?

In particolare, preferisco non avere un file .Rd perché utilizzo il gancio .onLoad() nel mio pacchetto. Questa funzione è già documentata nel pacchetto base quindi non c'è motivo per me di ri-documentarlo.

risposta

14

Bene, ho finalmente trovato e sfogliato l'elenco di Roxygen-devel allo R-forge per vedere quando questo sarebbe stato implementato, e sembra essere già nella versione di Roxygen che si trova su CRAN. La chiave è specificare use.Rd2=TRUE quando si chiama roxygenize(). In questa modalità, Roxygen salterà la creazione di documentazione per tutte le funzioni che non sono precedute dai commenti di Roxygen.

+1

+1 Grazie per il seguito. – Shane

+3

In roxygen2, è anche possibile usare '@ noRd' per sopprimere la creazione sui file Rd anche se si dispone della documentazione di roxygen2. – hadley

2

Questo è nella loro lista delle cose da fare - nella prossima versione, solo le funzioni con la documentazione di roxygen creeranno i file man.