This is an example of Markdown vignettes using the Docco style.
To use the Docco style for Markdown vignettes in an R package, you need to
*.Rmd
files under the vignettes
directorySuggests: knitr
and VignetteBuilder: knitr
to the DESCRIPTION
file\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')
Below are some code chunks as examples.
cat('_hello_ **markdown**!', '\n')
hello markdown!
Normally you do not need any chunk options.
1+1
## [1] 2
10:1
## [1] 10 9 8 7 6 5 4 3 2 1
rnorm(5)^2
## [1] 0.02793468 0.06012960 2.93306336 0.58198017 0.04077861
strsplit('hello, markdown vignettes', '')
## [[1]]
## [1] "h" "e" "l" "l" "o" "," " " "m" "a" "r" "k" "d" "o" "w" "n" " " "v" "i" "g"
## [20] "n" "e" "t" "t" "e" "s"
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')
Custom CSS and JS files are passed to markdown::mark_html()
to style the HTML page:
knitr:::docco_linear
That is it.