Roxy dokümanı kullanarak resim dahil etme

Question

Roxygen tarafından üretilen dokümantasyona resim eklenebilir mi? Çıktının bir örneğini göstererek belgelemek istediğim ggplot() için temelde sarmalayıcılar olan bir dizi işlevim var. R 2.14 duyurulmasından itibaren değişim listesinin gereğince

Answer 1

: HTML veya LaTeX dönüştürüldüğünde rakamlar yardım sayfalarında yer alması, böylece

Rd biçimlendirme yeni \ figür etiketi vardır. Par() ve points() için yardım sayfalarında numaralı örnekler vardır. Gönderen

: http://cran.r-project.org/doc/manuals/R-exts.html#Figures

yardım sayfalarında rakamları dahil etmek için, \ rakam işaretlemeyi kullanabilirler. Üç form var.

Yaygın olarak kullanılan iki basit form \ şekil {dosyaadı} ve \ şekil {dosyaadı} {alternatif metin} şeklindedir. Bu, ya HTML ya da LaTeX çıkışındaki şeklin bir kopyasını içerecektir. Metin çıktısında, alternatif metin yerine görüntülenecektir. (İkinci argüman ihmal edildiğinde, dosya adı kullanılır.) Hem dosya adı hem de alternatif metin, verbatim olarak ayrıştırılır ve HTML veya LaTeX'te önemli olan özel karakterler içermemelidir.

Uzman form \ şekil {dosyaadı} {options: string} şeklindedir. ('Options:' kelimesi tam olarak gösterildiği gibi yazılmalı ve en az bir alan eklenmelidir.) Bu formda, dize, src özniteliğini izleyen öznitelikler olarak HTML img etiketine veya \ 'nin ikinci argümanına kopyalanır. LaTeX'te, varsayılan olarak \ includegraphics çağrısı için seçenekler olarak kullanılan şekil makrosu. Her iki görüntüleme modu için de herhangi bir tek dizenin yeterli olamayacağı ihtimalinden dolayı, uzman formu normal şartlarda sarılacaktır. Yasal HTML/LaTeX'in kullanıldığından emin olmak yazarına kalmıştır. rakamları içeren

\if{html}{\figure{logo.jpg}{Our logo}} 
\if{latex}{\figure{logo.jpg}{options: width=0.5in}} 

dosya dizin insanda saklanmalıdır: Örneğin, bir hem HTML logosu (basit formunu kullanarak) ve LaTeX (uzman formunu kullanarak), şu kullanılabilir içerecek şekilde/figürleri. Bu dizinden .jpg, .pdf, .png ve .svg uzantılı dosyalar, yükleme zamanında yardım/şekiller dizinine kopyalanacaktır. (PDF biçimindeki rakamlar çoğu HTML tarayıcısında görüntülenmeyecektir, ancak referans kılavuzlarında en iyi seçim olabilir.) Dosya adını, \ şekil yönergesindeki ada/şekillere göre belirtin.