2015-06-24 5 views
8

Ich bin neu zu schreiben R-Pakete. Ich versuche zu lernen, wie man eine Vignette für mein Paket macht. Ich habe erstellt s Vignetten Ordner mit einer Datei getting-started.RmdWie erstellt man eine pdf-Vignette in R und RStudio

--- 
title: "WaterML Tutorial" 
author: "Jiri Kadlec" 
date: "`r Sys.Date()`" 
output: rmarkdown::html_vignette 
vignette: > 
    %\VignetteIndexEntry{Introduction to the WaterML R package} 
    %\VignetteEngine{knitr::rmarkdown} 
    %\VignetteEncoding{UTF-8} 
--- 

## Quick Start 

This simple example shows how to get started with the my R package. 

Um die Vignette zu bauen ich verwenden Sie den Befehl:

devtools::build_vignettes() 

Dann laufe ich Rcmd.exe INSTALL my_package und meine Vignette zu sehen Ich betreibe:

browseVignettes("my_package") 

aber ich sehe nur die Vignetten in den hTML-Code und Quellformat: I don't see the pdf option for vignettes

Wie Sie auf dem Screenshot sehen, gibt es keine "pdf" -Option. Wie konfiguriere ich meine .RMD-Datei, um meine Vignette im PDF-Format zu erstellen?

+0

Ist Ihre Frage beantworten? http://stackoverflow.com/questions/30936969/enforce-pdf-package-vignette-with-knitr oder möglicherweise versuchen [output: pdf_document] (http://rarkdown.studio.com/pdf_document_format.html)? –

Antwort

5

In der Kopfzeile, sagen Sie R nur eine HTML-Vignette in Zeile Ausgabe:

output: rmarkdown::html_vignette 

Wenn Sie pdf wollen, versuchen Sie:

output: pdf_document 

Nach R packages:

Ausgabe: Dies teilt Rmarkdown mit, welcher Ausgabeformatierer verwendet werden soll. Es gibt viele Optionen, die für regelmäßige Berichte nützlich sind (einschließlich HTML, PDF, Diashows, ...), aber rmarkdown :: html_vignette wurde speziell dafür entwickelt, gut in Paketen zu funktionieren. Weitere Informationen finden Sie unter rmarkdown :: html_vignette.

Sie könnten also ein paar kleine Probleme mit einem rohen PDF haben.

Zu diesem Zeitpunkt hat rmarkdown keine output: rmarkdown::pdf_vignette Option

+8

Und es gibt keine Notwendigkeit, eine "Ausgabe: Rmarkdown :: pdf_vignette" -Option ('pdf_document' wird einfach funktionieren). Der Grund für 'html_vignette' wird hier erklärt: http://rarkdown.rstudio.com/package_vignette_format.html –

+0

Gute Erklärung. So sehe ich, dass html_vignette das bevorzugte Format in R-Paketen ist, da die Größe viel kleiner ist. – jirikadlec2