8
Sto scrivendo un pacchetto R e sto documentando tutte le mie funzioni con roxygen2. Tuttavia, non voglio che tutte le funzioni appaiano nel manuale del pacchetto. Come è possibile specificare quali funzioni devono essere visualizzate nel manuale del pacchetto o quali no?Escludi la funzione dal manuale del pacchetto R
Sono consapevole che nominare una funzione con un punto iniziale, ad es. .f <- function() invece di f <- function() è una soluzione. Ci sono altre soluzioni?
Perché documentarli se non li vuoi nel manuale? – nrussell
Perché è utile sia per me che quando richiamo ciò che le funzioni fanno, sia per gli altri che potrebbero voler usare le funzioni "nascoste". Credo di aver visto esempi in altri pacchetti in cui non sono riuscito a trovare la pagina di aiuto della funzione scrivendo '? Function_name' nella console dopo aver importato il pacchetto, ma sono riuscito a vedere la pagina di aiuto se ho scritto'? Pkgname: :: function_name'. Potrei ricordare però sbagliato. –
Ma le funzioni a cui si accede con ':::' non vengono esportate dai pacchetti, che in genere significa che l'autore non ha intenzione di utilizzare la funzione per i client. Generalmente tali funzioni non sono documentate - ad es. 'strumenti :::. is_ASCII'. Direi che se si incontra una funzione non esportata che * ha * ha documentazione, molto probabilmente è stata precedentemente una funzione esportata (e documentata) e rimossa dall'elenco delle esportazioni in una versione successiva. – nrussell