2015-01-28 17 views
7

Görselleştirme işlevini bir paketimde belgelemek için çalışıyorum. Bu amaçla fonksiyonda kullanılan çeşitli parametreleri açıklayabilen 'funcname.Rd' Rd-dosyası aracılığıyla gömülü bir imaja sahip olmak isterim ve eğer kullanıcı paket PDF'sini okuyorsa ya da '? Funcname yazıyorsa açılır. 'hatlarında R. Something:R-package documentation (.Rd) dosyalarında resim dahil

Manual example

' Yazma R extensions'-belge bu sorunu gidermek için görünmüyor ve bulabildiğim tek referanslar this blog post ve this R-devel discussion idi. Birincisi, 'base64' adında bir pakete kopmuş bir bağlantıya sahip ve ikincisi, R paketindeki vinyetlerin görüntüleri dahil olmak üzere sadece çeşitli alternatifleri ele alıyor. Bu eğer CRAN uyumlu olabilirse harika olurdu.

Bu konuya nasıl yaklaşacağınız konusunda herhangi bir tavsiye memnuniyetle karşılanacaktır, teşekkürler!

+1

Rd dosyanızın düz metne dönüştürülmesi mümkün olmalıdır. Muhtemelen örneklerde böyle bir figür üreten kod eklemeyi tercih ederim. – Roland

+0

Bu, R-devel tartışmasında önerdikleri çalışmalardan bir tanesidir; Görünüşe göre 'example (funcname)' kullanmak insanların kullandığı bir şeydir. R tarafından üretilen figürler, farklı parametrelerin ne yaptığını göstermek için şekillerde birkaç stilize çizgiye, küme parantezine vb. Sahip olmak istedim ve bunu sadece R'de yapmak oldukça rahatsız edici olabilir. Ama sen haklısın. –

+2

Sadece bazı (birçok?) Kullanıcının bu rakamı görmeyeceğini unutmayın. Örneğin, bir komut satırından çalışıyorlarsa. – Roland

cevap

10

Untested ama GitHub'dan R kaynakta bakın, onlar aşağıdaki şekilde ?par documentation file bir resim eklemek görünür:

\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}} 
    } 

rakam /man/figures kaydedilmiş gibi görünür.

+0

Teşekkürler! Kontrol edeceğim. –

+1

Bu şu anda en iyi yol gibi görünüyor, cevap kabul edildi. Amacım gayet iyi çalışıyor, ancak Roland'ın yukarıdaki yorumlarında belirttiği gibi, tüm kullanıcıların rakamları görmesini beklememeliyim. –

+2

Gelecekte bu soru üzerine gelen herkes için sadece bir FYI. Yukarıda belirtilen sözdizimi iyi çalışıyor! – schifferl

İlgili konular