Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The html_vignette
output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible. The html_vignette
format:
Note the various macros within the vignette
section of the metadata block above. These are required in order to instruct R how to build the vignette. Note that you should change the title
field and the \VignetteIndexEntry
to match the title of your vignette.
Item 2
It's possible to put multiple paragraphs of text in a list item.
But to do that, the second and subsequent paragraphs must be indented by four or more spaces. It looks better if the first bullet is also indented.
Item 1
Items are numbered automatically, even though they all start with 1.
Item 1.
Definition : a statement of the exact meaning of a word, especially in a dictionary.
List : a number of connected items or names written or printed consecutively, typically one below the other. : barriers enclosing an area for a jousting tournament.
italic or italic
bold or bold
link text
http://this-is-a-raw-url.com
| Right | Left | Default | Center | |------:|:-----|---------|:------:| | 12 | 12 | 12 | 12 | | 123 | 123 | 123 | 123 | | 1 | 1 | 1 | 1 |
The html_vignette
template includes a basic CSS theme. To override this theme you can specify your own CSS in the document metadata as follows:
output: rmarkdown::html_vignette: css: mystyles.css
The figure sizes have been customised so that you can easily put two images side-by-side.
plot(1:10) plot(10:1)
You can enable figure captions by fig_caption: yes
in YAML:
output: rmarkdown::html_vignette: fig_caption: yes
Then you can use the chunk option fig.cap = "Your figure caption."
in knitr.
You can write math expressions, e.g. $Y = X\beta + \epsilon$, footnotes^[A footnote here.], and tables, e.g. using knitr::kable()
.
knitr::kable(head(mtcars, 10))
# Add two numbers together add <- function(a, b) a + b add(10, 20)
pander::pandoc.table(iris[1:3, 1:4])
Also a quote using >
:
"He who gives up [code] safety for [code] speed deserves neither." (via)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.