Alcuni pacchetti R (ad esempio, , dplyr, devtools ecc.) Hanno sezioni alfabeticamente intitolate nella loro guida/documentazione e una barra di collegamenti a tali sezioni (indicate dalle frecce rosse nella figura sotto). Altri pacchetti (ad es. RcmdrMisc) non hanno.Aggiungere sezioni alla guida/documentazione del pacchetto R
Come posso aggiungere questi elementi alla domanda del pacchetto R?
io uso roxygen2 per la documentazione.
nella scrittura R estensioni di file (incluso in ogni copia di R da CRAN) è una piccola sezione per quanto riguarda il file INDEX:
1.1.4 Il file INDEX
L'INDICE file opzionale contiene una linea per ogni oggetto sufficientemente interessante nel pacchetto, che fornisce il suo nome e una descrizione (funzioni come i metodi di stampa che di solito non vengono chiamate esplicitamente potrebbero non essere incluse). Normalmente questo file è mancante e le informazioni corrispondenti vengono generate automaticamente dalle origini della documentazione (usando
tools::Rdindex()) quando si installa dall'origine.
Quando i pacchetti hanno un file di indice, il codice HTML si trova nella cartella html.
Ho trovato la cartella 'html' nella versione installata del mio pacchetto, ma ancora non capisco, come creare sezioni. Function 'tools :: Rdindex()' è responsabile della creazione del file HTML con index durante l'installazione di un pacchetto? – Vilmantas
Questa è la mia comprensione del solito processo. Automagici. –
Buona domanda! Immagino che il codice sorgente dei pacchetti possa dare una risposta (se nessuno lo sa). –
Per quanto ne so, questi file indice sono generati automaticamente. Almeno, i miei pacchetti li hanno sempre, ma non li scrivo mai. Ho sempre pensato che queste lettere vengano aggiunte automaticamente, una volta che l'elenco delle funzioni diventa abbastanza lungo. Ma potrei sbagliarmi. – Stibu
Ho studiato una struttura di alcuni pacchetti su GitHub, ma non ho trovato ancora come rendere quell'indice alfabetico. – Vilmantas