È possibile includere un'immagine nella documentazione generata da roxygen? Ho un certo numero di funzioni che sono essenzialmente wrapper per ggplot() che mi piacerebbe documentare mostrando un esempio dell'output.Includere un'immagine utilizzando la documentazione di roxygen
Come per la lista passaggio da l'annuncio di R 2.14:
Rd markup ha un nuovo tag \ figura, in modo che i dati possono essere inclusi in pagine di aiuto una volta convertito in HTML o LaTeX. Ci sono esempi su le pagine di aiuto per par() e points().
Da: http://cran.r-project.org/doc/manuals/R-exts.html#Figures
Per includere figure in pagine della guida, utilizzare il \ figura di markup. Ci sono tre forme.
Le due forme semplici comunemente utilizzate sono \ figure {nomefile} e \ figura {nomefile} {testo alternativo}. Ciò includerà una copia della figura in output HTML o LaTeX. Nell'output di testo, verrà invece visualizzato il testo alternativo. (Quando viene omesso il secondo argomento, verrà utilizzato il nome file). Sia il nome file che il testo alternativo verranno analizzati verbatim e non dovrebbero includere caratteri speciali significativi in HTML o LaTeX.
La forma dell'esperto è \ figure {nomefile} {opzioni: stringa}. (La parola "opzioni:" deve essere digitata esattamente come mostrato e seguito da almeno uno spazio.) In questo modulo, la stringa viene copiata nel tag HTML img come attributi che seguono l'attributo src o nel secondo argomento di \ Figura macro in LaTeX, che per impostazione predefinita viene utilizzata come opzioni per una chiamata \ includegraphics. Poiché è improbabile che una singola stringa sia sufficiente per entrambe le modalità di visualizzazione, la forma dell'esperto verrebbe normalmente racchiusa in condizionali. Spetta all'autore assicurarsi che venga utilizzato HTML/LaTeX legale. Ad esempio, per includere un logo sia in HTML (utilizzando il modulo semplice) e LaTeX (utilizzando il modulo esperto), potrebbe essere utilizzato il seguente:
\if{html}{\figure{logo.jpg}{Our logo}}
\if{latex}{\figure{logo.jpg}{options: width=0.5in}}
I file contenenti i dati devono essere conservati in l'uomo directory/figure. I file con estensioni .jpg, .pdf, .png e .svg da quella directory verranno copiati nella directory help/figures al momento dell'installazione. (Le figure in formato PDF non verranno visualizzate nella maggior parte dei browser HTML, ma potrebbero essere la scelta migliore nei manuali di riferimento.) Specificare il nome file relativo a man/figure nella direttiva \ figure.
Basta usare la consueta sintassi Rd – hadley
Se potessi trovarlo, non avrei chiesto. L'unico elenco completo di sintassi che sono riuscito a trovare era il bioconducter ... e non includeva la sintassi per includere un'immagine. –
E anche in "Scrivi R Estensioni". –