Skip to contents

Set or show default rendering options

Source: R/options.R
latex_options.Rd

Sets defaults for latex_grob(), grid.latex(), latex_dims(), latex_tree() and the markdown functions. An argument given in a call always wins over the default.

Usage

latex_options(
  math_font = NULL,
  render_mode = NULL,
  tex_style = NULL,
  input_mode = NULL,
  justify = NULL,
  line_break = NULL,
  markdown_style = NULL,
  device_math = NULL
)

reset_latex_options()

Arguments

math_font

Math font; see available_math_fonts().

render_mode

"typeface" or "path"; see latex_grob().

tex_style

"", "display", "text", "script" or "scriptscript"; see latex_grob().

input_mode

"mixed", "math" or "document"; see latex_grob().

justify

If TRUE, stretch wrapped lines to fill max_width.

line_break

"greedy" or "optimal"; see latex_grob().

markdown_style

Default style for markdown_grob() and markdown_box_grob(): a markdown_style(), CSS text, or a path to a .css file.

device_math

If TRUE, any plot label containing math, such as "Slope $x^2$", is typeset as LaTeX. This works for base graphics (main, xlab, text(), legend(), ...), and also for lattice, grid and ggplot2. Labels without math, such as "Cost $5-$10", are left alone.

Heights are not adjusted: a tall formula can overflow a margin or a legend() box. Measure it with latex_dims() and make room with par(mar = ). See vignette("base-graphics") for the rules and limitations.

Value

The previous settings, invisibly. With no arguments, the current settings.

Details

With no arguments, returns the current settings (NULL means the built-in default). Setting an option to NULL resets it. The previous settings are returned, so do.call(latex_options, old) restores them.

Size and line spacing are set with gp (fontsize, cex, lineheight), not here.

See also

available_math_fonts(), latex_grob()

Examples

# \donttest{
  old <- latex_options(math_font = "stix", render_mode = "typeface")
  grid.latex("$\\sum_{i=1}^{n} i^{2}$", gp = grid::gpar(fontsize = 14))

  do.call(latex_options, old)

  # Math in base graphics, with no other change to the plotting code.
  latex_options(device_math = TRUE)
  plot(1:10, (1:10)^2,
       main = "Slope $\\hat{\\beta}_1 = \\sum_{i=1}^{n} x_i^2$",
       ylab = "$y^2$")

# }