Tufte-style HTML in rmarkdown
Michael Sachs
2014-11-07
Introduction
This is an R Markdown document. Markdown is a simple formatting syntax for authoring HTML, PDF, and MS Word documents. This package provides output formats to create “Tufte-style” handouts.
Tufte-style handouts make heavy use of the right margin. Our package provides templates for creating these types of documents in html format. The pdf format is now part of rmarkdown and uses the tufte-handout document class.
The html format uses bootstrap with some css to put stuff in the margin. Each uses knitr hooks to specify the types of figures. Pdf versions of tufte handouts can be made with the rmarkdown function tufte_handout.
Usage
To create sidenotes in html, some raw html is required. We make use of the aside tag. Place the sidenote content between the tags <aside></aside> to place them in the sidebar. In the pdf version, simply use the pandoc footnote format ^[Content]. Anything can be enclosed in the aside tag, even code!
The package provides two custom hooks for figure placement. The first is marginfigure. Set marginfigure = TRUE in a chuck option to place a figure in the right margin. Optionally, specify the figure size and include a caption. Captions are passed as strings through fig.cap in the chunk options.
library(ggplot2)
ggplot(mtcars, aes(y = mpg, x = wt)) + geom_point() + stat_smooth(method = "lm")The html documents have the body set at a fixed width of 960px. Feel free to edit the css to suit your needs. Html output supports any of the built in Bootstrap themes. Be careful using the fluid grid system, it may break the output for narrow screens.
The second custom hook is fig.star. Setting fig.star = TRUE creates a full-width figure spanning the main body and the margin. The caption goes in the sidebar under the figure. These look pretty sweet! Specify the width and height for best results.
ggplot(faithful, aes(y = eruptions, x = waiting)) + geom_point() + stat_smooth(method = "loess")
Finally, normal figures are plotted in the main body, with the captions in the margin. The only option necessary here is the caption itself.
ggplot(faithful, aes(x = eruptions)) + geom_histogram(binwidth = 0.1)
