2015-06-24 21 views
8

Sono nuovo nella scrittura di pacchetti R. Sto cercando di imparare come creare una vignetta per il mio pacchetto. cartella ho creato s vignette con un file getting-started.RmdCome creare una vignetta in PDF in R e 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. 

Per costruire la vignetta uso il comando:

devtools::build_vignettes() 

Poi corro Rcmd.exe INSTALL my_package, e per osservare il mio vignetta corro:

browseVignettes("my_package") 

Tuttavia vedo solo le vignette in formato HTML e la fonte: I don't see the pdf option for vignettes

Come si vede nello screenshot, non esiste l'opzione "pdf". Come configuro il mio file .Rmd per creare la mia vignetta in formato pdf?

+0

Questo è stato esauriente? http://stackoverflow.com/questions/30936969/enforce-pdf-package-vignette-with-knitr o possibilmente provare [output: pdf_document] (http://rmarkdown.rstudio.com/pdf_document_format.html)? –

risposta

5

nell'intestazione, si indica R per l'uscita solo vignetta HTML in linea:

output: rmarkdown::html_vignette 

Se volete pdf, provare:

output: pdf_document 

Secondo R packages:

Uscita: indica a rmarkdown quale formattatore di uscita usare. Ci sono molte opzioni che sono utili per i rapporti regolari (tra cui html, pdf, slideshow, ...) ma rmarkdown :: html_vignette è stato specificamente progettato per funzionare bene all'interno dei pacchetti. Vedi? Rmarkdown :: html_vignette per maggiori dettagli.

Quindi potresti avere qualche piccolo problema utilizzando un pdf non elaborato.

In questo momento, rmarkdown non dispone di un output: rmarkdown::pdf_vignette opzione

+8

E non è necessario avere l'opzione 'output: rmarkdown :: pdf_vignette' (' pdf_document' funzionerà semplicemente). Il motivo per "html_vignette" è spiegato qui: http://rmarkdown.rstudio.com/package_vignette_format.html –

+0

Buona spiegazione. Quindi vedo che html_vignette è il formato preferito nei pacchetti R perché la dimensione è molto più piccola. – jirikadlec2

Problemi correlati