2012-12-12 36 views
12

C'è un modo semplice per creare un file di documentazione R per semplici funzioni R?Come creare un file di documentazione R (.Rd) in lattice?

So che posso modificare un file .Rd in R-studio e visualizzarlo in anteprima nel file HTML. Ma come metterlo in lattice per modificare e vedere in anteprima? C'è qualche pacchetto in lattice che produce il formato di documentazione R?

+2

Puoi dare qualche altro contesto per il motivo per cui devi farlo? Stai cercando di scrivere un singolo file di documentazione autonomo? Stai scrivendo un pacchetto? – joran

+0

I file Rd utilizzano il proprio linguaggio di markup semplificato; di solito sono scritti a mano, ma una soluzione più scalabile è usare roxygen2 per produrre i file Rd per voi dai commenti nel file sorgente. – baptiste

risposta

10

C'è la funzione Rd2latex nel pacchetto strumenti che converte dal formato .Rd al formato LaTeX. Questo ti permetterà di vedere in anteprima la documentazione su LaTeX. Tuttavia, ciò non consente di convertire le modifiche nel documento LaTeX nel documento .Rd.

+0

Certo, certo, ho pensato che fosse più educato commentare che arare il tuo post. Dobbiamo rimuovere anche questi commenti? Inizierò... –

2

Cerca Sweave, forse è utile per te.

Sweave è uno strumento che consente di incorporare il codice R per analisi complete dei dati nei documenti in lattice.

Lo scopo è creare report dinamici, che possono essere aggiornati automaticamente se i dati o l'analisi cambiano. Invece di inserire un grafico o una tabella prefabbricati nel report, il documento master contiene il codice R necessario per ottenerlo. Quando si scorre attraverso R, tutti gli output di analisi dei dati (tabelle, grafici, ecc.) Vengono creati al volo e inseriti in un documento finale in lattice.

Il rapporto può essere aggiornato automaticamente se i dati o l'analisi cambiano, il che consente una ricerca realmente riproducibile.

0

Provate il pacchetto knitr, un modo semplice per generare report dinamici flessibili e veloci con R per LaTex.

1

Check out printr http://yihui.name/printr/. Dovrebbe fare ciò che ti serve se usi knitr.

Il problema con Rd2latex è che non ho capito quale file di stile devo usare, altrimenti funziona correttamente.

1

Quando si genera il codice in lattice con la funzione Rd2latex, assicurarsi di copiare il file Rd.sty dalla directory R, ​​incollarlo e da qualche parte che il lattice può vederlo e utilizzare \usepackage{Rd}.

Problemi correlati