Example Vignette Documentation

FC Reporting

2017-06-19

Vignettes are 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:

Vignette Info

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.

Sub Header

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

Figures Can be included quite easily

The figure sizes have been customised so that you can easily put two images side-by-side.

ggplot(data = pr.egh) +
  geom_bar(aes(`Taste Tests`, fill = `Assessment`))


taste.portion <- ggplot(data = pr.egh) +
  geom_bar(aes(`School Tastings Offered`, fill = `Assessment`),
           position = "fill")
   taste.portion  + facet_grid(.~`Program State: Program State Name`)

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.

More Examples

You can write tables, footnotes1, and tables, e.g. using knitr::kable().

Program State: Program State Name Account Name Taste Tests
Mississippi PECAN PARK ELEMENTARY SCHOOL Yes
Oregon CESAR CHAVEZ K-8 SCHOOL No
New Jersey Salem County Career and Technical High School Yes
Montana CHERRY VALLEY SCHOOL Yes
North Carolina OAK HILL ELEMENTARY Yes
Iowa CARVER ELEMENTARY Yes
Maine RIVERTON SCHOOL Yes
California Balboa Middle Yes
New Mexico SANTO DOMINGO ELEMENTARY Yes
Montana CORNELIUS HEDGES SCHOOL Yes
Post Pre
No 142 217
Yes 202 164
Also a quote using >:

“He who gives up [code] safety for [code] speed deserves neither.” (via)

  1. A footnote here.↩