Package 'tufte' reference manual

Title:	Tufte's Styles for R Markdown Documents
Description:	Provides R Markdown output formats to use Tufte styles for PDF and HTML output.
Authors:	Yihui Xie [aut] , Christophe Dervieux [ctb, cre] , JJ Allaire [aut], Andrzej Oles [ctb], Dave Liepmann [ctb] (Tufte CSS in inst/rmarkdown/templates/tufte_html/resources), Posit Software, PBC [cph, fnd]
Maintainer:	Christophe Dervieux <[email protected]>
License:	GPL-3
Version:	0.13.1
Built:	2024-11-14 03:28:44 UTC
Source:	https://github.com/rstudio/tufte

Tufte handout formats (PDF and HTML)

Description

Templates for creating handouts according to the style of Edward R. Tufte and Richard Feynman.

Usage

tufte_handout(
  fig_width = 4,
  fig_height = 2.5,
  fig_crop = TRUE,
  dev = "pdf",
  highlight = "default",
  ...
)

tufte_book(
  fig_width = 4,
  fig_height = 2.5,
  fig_crop = TRUE,
  dev = "pdf",
  highlight = "default",
  ...
)

tufte_html(
  ...,
  tufte_features = c("fonts", "background", "italics"),
  tufte_variant = c("default", "envisioned"),
  margin_references = TRUE
)

newthought(text)

margin_note(text, icon = "&#8853;")

quote_footer(text)

sans_serif(text)
tufte_handout(
  fig_width = 4,
  fig_height = 2.5,
  fig_crop = TRUE,
  dev = "pdf",
  highlight = "default",
  ...
)

tufte_book(
  fig_width = 4,
  fig_height = 2.5,
  fig_crop = TRUE,
  dev = "pdf",
  highlight = "default",
  ...
)

tufte_html(
  ...,
  tufte_features = c("fonts", "background", "italics"),
  tufte_variant = c("default", "envisioned"),
  margin_references = TRUE
)

newthought(text)

margin_note(text, icon = "&#8853;")

quote_footer(text)

sans_serif(text)

Arguments

`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 `pdfcrop`. This requires the tools `pdfcrop` and `ghostscript` to be installed. By default, `fig_crop = TRUE` if these two tools are available.
`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 `NULL` to prevent syntax highlighting.
`...`	Other arguments to be passed to `pdf_document()` or `html_document()` (note you cannot use the `template` argument in `tufte_handout` or the `theme` argument in `tufte_html()`; these arguments have been set internally)
`tufte_features`	A character vector of style features to enable: `fonts` stands for the `et-book` fonts in the `tufte-css` project, `background` means the lightyellow background color of the page, and `italics` means whether to use italics for the headers. You can enable a subset of these features, or just disable all of them by `NULL`. When this argument is not used and the `tufte_variant` argument is not `default`, no features are enabled.
`tufte_variant`	A variant of the Tufte style. Currently supported styles are `default` (from the `tufte-css` project), and `envisioned` (inspired by the project `⁠Envisioned CSS⁠` https://github.com/nogginfuel/envisioned-css but essentially just sets the font family to `⁠Roboto Condensed⁠`, and changed the background/foreground colors).
`margin_references`	Whether to place citations in margin notes.
`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

tufte_handout() provides the PDF format based on the Tufte-LaTeX class: https://tufte-latex.github.io/tufte-latex/.

tufte_html() provides the HTML format based on the Tufte CSS: https://edwardtufte.github.io/tufte-css/.

newthought() can be used in inline R expressions in R Markdown

`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 https://rstudio.github.io/tufte/ for an example.

Examples

library(tufte)
newthought("In this section")
library(tufte)
newthought("In this section")

Package 'tufte'