tintHtml | R Documentation |
A template for creating html reports according to the style of
Edward R. Tufte and Richard Feynman, but with an updated font
choice. The three key functions tintHtml
, tintPdf
and tintBook
offer, respectively, support for html and
pdf-based shorter (“article-length” writeups as well as
support for longer pdf-based content.
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)
... |
Other arguments to be passed to
Note: For |
fig_width |
Default width (in inches) for figures |
fig_height |
Default height (in inches) for figures |
fig_crop |
Whether to crop PDF figures with the command
|
dev |
Graphics device to use for figure output (defaults to pdf) |
highlight |
Syntax highlighting style passed to Pandoc. Supported built-in styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "breezedark". Two custom styles are also included, "arrow", an accessible color scheme, and "rstudio", which mimics the default IDE theme. Alternatively, supply a path to a ‘.theme’ file to use a custom Pandoc style. Note that custom theme requires Pandoc 2.0+. Pass |
citation_package |
The LaTeX package to process citations, |
latex_engine |
LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex" and "tectonic". |
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) |
tintHtml
provides the HTML format based on the Tufte CSS
https://edwardtufte.github.io/tufte-css/ with fonts set according to
https://github.com/nogginfuel/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 (still somewhat 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
.
See https://rstudio.github.io/tufte/ for the tufte package this was initially derived from. See https://eddelbuettel.github.io/tint/ for usage examples from this package.
Custom-templates, YAML-metadata.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.