In mienkoja/oliveR: A package for extracting data from the oliver SMS replica and creating measurements

This is a document to be used in the manual inspection of changes made to the oliveR package. As of the original date of this writing, we do not have a good way of checking to ensure that the svg output of oliveR is actually valid svg. This document makes use of the read_raw_svg_and_plot() function which accomplishes the following:

THIS IS MAINLY JUST THE TEMPLATE VIGNETTE FOR NOW IT WILL ULTIMATELY BE USED FOR TESTING PURPOSES

• Never uses retina figures
• Has a smaller default figure size
• Uses a custom CSS stylesheet instead of the default Twitter Bootstrap style

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.

Styles

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

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

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 math expressions, e.g. $Y = X\beta + \epsilon$, footnotes^[A footnote here.], and tables, e.g. using knitr::kable().

knitr::kable(head(mtcars, 10))

Also a quote using >:

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

mienkoja/oliveR documentation built on May 6, 2019, 6:01 p.m.