Skip to content
Prev 49377 / 63424 Next

Changing style for the Sweave vignettes

On 11/13/2014 03:09 AM, January Weiner wrote:
Vignettes do not need to be generated by Sweave and to pdf documents. My current 
favorite (e.g., recent course material at 
http://bioconductor.org/help/course-materials/ which uses styling from the 
BiocStyle package 
http://bioconductor.org/packages/release/bioc/html/BiocStyle.html) uses the 
knitr package (see http://yihui.name/knitr/) to produce HTML vignettes (knitr 
will also process Rnw files to pdf with perhaps more appealing styling, see, 
e.g.,  http://bit.ly/117OLVl for an example of PDF output).

The mechanics are discussed in Writing R Extensions (RShowDoc('R-exts')), 
section 1.4.2 Non-Sweave vignettes. There are three steps involved: specifying a 
\VignetteEngine in the vignette itself, specifying VignetteBuilder: field in the 
DESCRIPTION file, and including the package providing the engine (knitr, in my 
case) in the Suggests: field of the DESCRIPTION file.

Brian mentioned processing the vignette to it's underlying code; see 
?browseVignettes and ?vignette for installed packages, and ?Stangle in R and R 
CMD Stangle for extracting the R code from stand-alone vignettes to .R files.

Martin Morgan