tint (version 0.1.0)

tintHtml: Tint Is Not Tufte -- A Tufte-Inspired HTML Format

Description

A template for creating html reports according to the style of Edward R. Tufte and Richard Feynman, but with an updated font choice.

Usage

tintHtml(...)
tint(...)
tintPdf(fig_width = 4, fig_height = 2.5, fig_crop = TRUE, dev = "pdf",
  highlight = "tango", citation_package = "natbib",
  latex_engine = "pdflatex", ...)
tintBook(fig_width = 4, fig_height = 2.5, fig_crop = TRUE, dev = "pdf",
  highlight = "tango", citation_package = "natbib",
  latex_engine = "pdflatex", ...)
newthought(text)
margin_note(text, icon = "⊕")
quote_footer(text)
sans_serif(text)

Arguments

...

Other arguments to be passed to pdf_document or html_document (note you cannot use the template argument in tintPdf or the theme argument in tintHHtml(); these arguments have been set internally)

fig_width

Default width (in inches) for figures

fig_height

Default width (in inches) for figures

fig_crop

TRUE to automatically apply the pdfcrop utility (if available) to pdf figures

dev

Graphics device to use for figure output (defaults to pdf)

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.

citation_package

The LaTeX package to process citations, natbib or biblatex. Use none if neither package is to be used.

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", and "xelatex".

text

A character string to be presented as a “new thought” (using small caps), or a margin note, or a footer of a quote

icon

A character string to indicate there is a hidden margin note when the page width is too narrow (by default it is a circled plus sign)

Details

tintHtml provides the HTML format based on the Tufte CSS https://edwardtufte.github.io/tufte-css/ with fonts set according to http://nogginfuel.com/envisioned-css/. tintPdf provides a similar PDF format using the same font family and styling applied to the Tufte-LaTeX https://tufte-latex.github.io/tufte-latex/ class. tintBook is a (currently rather experimental) pdf book variant.

newthought() can be used in inline R expressions in R Markdown (e.g. `r newthought(Some text)`), and it works for both HTML (<span class="newthought">text</span>) and PDF (\newthought{text}) output.

margin_note() can be used in inline R expressions to write a margin note (like a sidenote but not numbered).

quote_footer() formats text as the footer of a quote. It puts text in <footer></footer> for HTML output, and after \hfill for LaTeX output (to right-align text).

sans_serif() applies sans-serif fonts to text.

References

See http://rstudio.github.io/tufte for an example.

Examples

# NOT RUN {
library(tint)

# }