tufte_handout: FUNCTION_TITLE

View source: R/tufte_handout.R

tufte_handoutR Documentation

FUNCTION_TITLE

Description

FUNCTION_DESCRIPTION

Usage

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

newthought(text)

margin_note(text, icon = "⊕")

quote_footer(text)

sans_serif(text)

Arguments

fig_width

PARAM_DESCRIPTION, Default: 4

fig_height

PARAM_DESCRIPTION, Default: 2.5

fig_crop

PARAM_DESCRIPTION, Default: TRUE

dev

PARAM_DESCRIPTION, Default: 'pdf'

highlight

PARAM_DESCRIPTION, Default: 'default'

...

PARAM_DESCRIPTION

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

DETAILS

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.

Value

OUTPUT_DESCRIPTION

Examples

## Not run: 
if (interactive()) {
  # EXAMPLE1
}

## End(Not run)
newthought("In this section")

jtrampush/npsych.data documentation built on Feb. 25, 2025, 12:30 a.m.