An R Markdown (v1) Vignette with knitr

This is an example of Markdown vignettes in R. Before R 3.0.0, only Sweave/PDF vignettes were supported in R. Markdown is gaining popularity over the years due to its simplicity, and R 3.0.0 starts to support package vignettes written in R Markdown.

Please note this example is for R Markdown v1 only. If you use R Markdown v2, you should use the vignette engine knitr::rmarkdown instead of knitr::knitr.

Package vignettes

To enable Markdown vignettes in an R package, you need to

View vignettes

And R will load the knitr package to build these vignettes to HTML files, and you can see them when you open the HTML help:

help(package = 'YourPackage', help_type = 'html')
# or see a standalone list of vignettes


Below are some code chunks as examples.

if (TRUE) cat('_hello_ **markdown**!', '\n')

Normally you do not need any chunk options.

strsplit('hello, markdown vignettes', '')

Feel free to draw beautiful plots and write math $P(X>x)=\alpha/2$.

n=300; set.seed(123)
plot(rnorm(n), rnorm(n), pch=21, cex=5*runif(n), col='white', bg='gray')

Try the knitr package in your browser

Any scripts or data that you put into this service are public.

knitr documentation built on June 22, 2024, 9:25 a.m.