Includere immagini nei file di documentazione R-package (.Rd)

Sto lavorando per documentare una funzione di visualizzazione in un mio pacchetto. A tale scopo mi piacerebbe avere un'immagine incorporata tramite il file Rd 'funcname.Rd' che potrebbe spiegare vari parametri utilizzati nella funzione, e che apparirebbe se l'utente andasse a leggere il PDF del manuale del pacchetto o scrivesse '? Funcname 'in R. Qualcosa nelle linee di:Includere immagini nei file di documentazione R-package (.Rd)

Manual example

' Scrittura R extensions'-documento non sembra per affrontare questo problema, e gli unici riferimenti che ho trovato erano this blog post e this R-devel discussion. Il primo ha un collegamento interrotto a un pacchetto chiamato 'base64' e quest'ultimo indirizza solo varie alternative come includere le immagini nelle vignette del pacchetto R. Sarebbe bello se questo potesse essere compatibile con CRAN.

Qualsiasi consiglio su come affrontare questo problema sarebbe apprezzato, grazie!

fonte

2015-01-28 Teemu Daniel Laajala

Deve essere possibile elaborare il file Rd in testo normale. Probabilmente preferirei includere il codice che produce tale figura negli esempi. – Roland

Questa è approssimativamente una delle soluzioni che hanno suggerito nella discussione su R-devel; apparentemente usando 'esempio (funcname)' è qualcosa che le persone hanno usato. La cosa con le figure prodotte da R è che volevo avere diverse linee stilizzate, parentesi graffe, ecc. Nella figura per indicare i diversi parametri, e farlo solo in R può essere piuttosto scomodo. Ma tu hai ragione. –

Tieni presente che alcuni (molti?) Utenti non vedranno la figura. Ad esempio, se funzionano da una riga di comando. – Roland

testato, ma guardare il sorgente R su GitHub, sembrerebbe che aggiungere un'immagine per ?par documentation file nel modo seguente:

\item{\code{mai}}{A numerical vector of the form \code{c(bottom, 
     left, top, right)} which gives the margin size specified in 
     inches.\cr 
     \if{html}{\figure{mai.png}{options: width="35\%" alt="Figure: mai.png"}} 
     \if{latex}{\figure{mai.pdf}{options: width=7cm}} 
    }

La figura sembra essere salvati in /man/figures.

fonte

2015-01-28 10:16:35

Grazie! Lo guarderò. –

Questo sembra essere al momento il modo migliore, risposta accettata. Per il mio scopo funziona bene, ma come Roland ha sottolineato nei suoi commenti sopra, non bisogna aspettarsi che tutti gli utenti vedano le cifre. –

Solo una FYI per chiunque accada su questa domanda in futuro. La sintassi sopra specificata funziona bene! – schifferl

Includere immagini nei file di documentazione R-package (.Rd)

risposta

Problemi correlati