In yihui/knitr: A General-Purpose Package for Dynamic Report Generation in R

This is an example of Markdown vignettes using the Docco style.

Docco

To use the Docco style for Markdown vignettes in an R package, you need to

• add *.Rmd files under the vignettes directory
• add Suggests: knitr and VignetteBuilder: knitr to the DESCRIPTION file
• specify the vignette engine \VignetteEngine{knitr::docco_linear} in the Rmd files (inside HTML comments)

After building and installing the package, you can view vignettes via

browseVignettes(package = 'Your_Package')

Examples

Below are some code chunks as examples.

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

Normally you do not need any chunk options.

1+1
10:1
rnorm(5)^2
strsplit('hello, markdown vignettes', '')

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

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

How does it work

Custom CSS and JS files are passed to markdown::mark_html() to style the HTML page:

knitr:::docco_linear

That is it.

yihui/knitr documentation built on Nov. 14, 2024, 3:14 p.m.