Kann ich ein PDF-Dokument in den Ordner pkg / doc einfügen, damit die Funktion vignette funktioniert, aber kein entsprechendes Rnw, Rtex usw. existiert?
Ich denke an Folien oder Dokumente, die Abschrift-Text enthalten, der mit R-Chunks gewebt wurde, die einen anderen Build-Prozess und damit andere Dateierweiterungen haben.
Das Schreiben von R-Erweiterungen schlägt vor, dass es möglich sein sollte, Dokumente einzuschließen, die zur Installationszeit nicht erstellt werden können, aber die vignette -Funktion scheint nach Dateien mit speziellen Erweiterungen (Rnw, Rtex, etc) zu suchen und auch nach eine Datei namens vignette.rds .
Alle Hinweise sind willkommen.
(Cross-gepostet von einer Antwort, die ich gerade auf R-help hinterlassen habe : )
Als Workaround können Sie Ihre eigene Funktion xvignette in Ihr Paket einfügen: siehe unten.
Es zeigt Ihnen keine Indizes an, aber es wird jede passend benannte Datei aufnehmen, die Sie in das inst/doc -Verzeichnis Ihrer einfügen
Paket ...
Sie müssen Ihre Paketbenutzer irgendwie darauf aufmerksam machen, dass diese alternative Dokumentation existiert - vielleicht in der Hilfedatei für das Paket selbst.
Sie können den Standardwert von pkg oben mit Ihrem Paketnamen ausfüllen, um es für den Benutzer einfacher zu machen: Ich habe überlegt, eine Variante von getPackageName(environment(xvignette)) zu verwenden, um das automatisch zu tun, aber das erscheint zu kompliziert ...
Brian Ripley erwähnte auch in seiner Antwort auf die Frage:
Gegenwärtig bedeutet Vignette () Swave-Dokumente, wie sie nur haben Metadaten wie Titel. Dies soll bald geändert werden.
... aber ich weiß nicht, was "bald" bedeutet (es wird etwa 6 Monate dauern, bis 2.14.0 herauskommt, denke ich)
Bearbeiten : Ссылка enthält eine weitere Problemumgehung (Erstellen eine Dummy-Vignette, die die vorhandene PDF-Datei enthält)
2 bearbeiten : Und
R.rsp -Paket Dies wird nativ ab R 3.0.0 unterstützt, siehe Ссылка .
Anleitung zur Verwendung von knitr als Vignetten-Engine auf:
- fügen Sie
%\VignetteEngine{knitr::knitr}dem QuelldokumentRnwhinzu (beachten Sie, dass Sie noch%\VignetteIndexEntry{}wie zuvor benötigen)- Geben Sie
anVignetteBuilder: knitrim Paket BESCHREIBUNG Datei- add
Suggests: knitrinDESCRIPTIONwennknitrnur für Vignetten benötigt wird
Siehe auch die offizielle R-Dokumentation zu diesem Thema.