Einbinden von Bildern in R-Package-Dokumentation (.Rd)

Ich arbeite daran, eine Visualisierungsfunktion in einem meiner Pakete zu dokumentieren. Zu diesem Zweck würde ich gerne ein Bild in die Rd-Datei 'funcname.Rd' eingebettet haben, das verschiedene Parameter erklären könnte, die in der Funktion verwendet werden, und die auftauchen würde, wenn der Benutzer das Pakethandbuch PDF lesen oder '? Funkname' schreibt ‚in R. Etwas in den Zeilen:Einbinden von Bildern in R-Package-Dokumentation (.Rd)

Manual example

‘ Writing R extensions'-Dokument scheint nicht dieses Problem zu beheben, und die einzigen Referenzen, die ich waren this blog post und this R-devel discussion finden konnte. Ersteres hat eine defekte Verbindung zu einem Paket namens "base64" und letzteres adressiert nur verschiedene Alternativen, wie zum Beispiel die Bilder in R-Paketvignetten. Es wäre großartig, wenn dies CRAN-kompatibel wäre.

Alle Ratschläge, wie Sie dieses Problem angehen würden, wären dankbar, danke!

Quelle

2015-01-28 Teemu Daniel Laajala

Es muss möglich sein, Ihre Rd-Datei in Klartext zu verarbeiten. Ich würde wahrscheinlich lieber Code einfügen, der eine solche Figur in den Beispielen erzeugt. – Roland

Dies ist einer der Work-Arounds, die in der R-devel-Diskussion vorgeschlagen wurden. scheinbar mit "example (funcname)" ist etwas, was Leute benutzt haben. Die Sache mit R-produzierten Figuren ist, dass ich mehrere stilisierte Linien, geschweifte Klammern usw. in der Figur haben wollte, um auf die verschiedenen Parameter hinzuweisen, und dies nur in R zu tun, kann ziemlich unbequem sein. Aber du hast Recht. –

Seien Sie sich bewusst, dass einige (viele?) Benutzer die Figur nicht sehen werden. Z. B. wenn sie von einer Befehlszeile aus arbeiten. – Roland

Ungeprüfte, aber Blick auf die R Quelle auf GitHub, es scheint sie ein Bild ?par documentation file auf folgende Weise hinzufügen:

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

Die Figur erscheint in /man/figures gespeichert werden.

Quelle

2015-01-28 10:16:35

Danke! Ich werde das überprüfen. –

Dies scheint im Moment der beste Weg zu sein, angenommene Antwort. Für meinen Zweck funktioniert es gut, aber wie Roland in seinen Kommentaren oben erwähnte, sollte man nicht erwarten, dass alle Benutzer die Zahlen sehen. –

Nur ein Vorgeschmack für alle, die in Zukunft auf diese Frage eingehen. Die oben angegebene Syntax funktioniert gut! – schifferl

Einbinden von Bildern in R-Package-Dokumentation (.Rd)

Antwort

Verwandte Themen