Può Roxygen ignorare le funzioni non-utenti?

Question

Ho appena iniziato a giocare con il pacchetto roxygen e non ho molto soddisfatti dei risultati ottenuti finora. Tuttavia mi chiedevo, c'è un modo per specificare per roxygen che dovrebbe ignorare alcune funzioni che non sono accessibili dall'utente?

In particolare, preferirei non avere un file .Rd pop-up perché sto utilizzando il gancio .onLoad() nel mio pacchetto. Questa funzione è già documentata nel pacchetto base quindi non c'è alcun motivo per me di ri-documento di esso.

Answer 1

Bene, ho finalmente trovato e navigato lista Roxygen-devel a R-forge per vedere quando questa sarebbe stata attuata, e sembra di essere già nella versione di Roxygen che si trova su CRAN. La chiave è di specificare use.Rd2=TRUE quando si chiama roxygenize(). In questa modalità, Roxygen salterà la creazione di documentazione per le funzioni che non sono preceduti da commenti Roxygen.

Answer 2

Questo è il loro elenco di fare - nella prossima versione, funziona solo con documentazione roxygen creeranno file man.

Answer 3

Utilizzare il campo parola chiave interna ( cioè. @keywords internal) per rimuovere la funzione dalla documentazione e renderlo disponibile solo per gli utenti esperti. Fonte:. roxygen2 vignetta