scuro_md: Intermediate markdown format

Description Usage Arguments Value See Also

Description

The strategy adopted by this package is to knit R markdown to markdown and then control the subsequent PDF generation using a Makefile to govern pandoc and latex. That lets us generate multiple PDFs from a single R markdown source without re-knitting.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
scuro_md(
  fig_width = 4.5,
  fig_height = 2.75,
  fig_crop = TRUE,
  highlight = "zenburn",
  highlight_paper = "monochrome",
  latex_engine = "xelatex",
  dev = "tikz",
  plot_font = "sansfont",
  plot_font_options = NULL,
  scuro = TRUE
)

Arguments

fig_width, fig_height

default figure dimensions (inches). Note that beamer slides have small "physical" dimensions: 128 mm x 96 mm or about 5 in x 3.75 in. The default values here are meant for slides with just one figure on them (and possibly a title and a caption).

fig_crop, latex_engine

same as for the built-in beamer_presentation, but XeLaTeX is the default engine

highlight

syntax highlighting scheme to be used on slides. Note that this option is currently only supported if specified in the R markdown source.

highlight_paper

syntax highlighting scheme to be used on handouts and notes. Note that this option is currently only supported if specified in the R markdown source.

dev

graphics device. "tikz" for TikZ graphics is the default, since one of the main points of this package is to transcend bad beamer fonts. This requires installing the tikzDevice package.

plot_font

if TikZ and XeLaTeX are used, the name of the main font for graphics. If "sansfont" (the default) or "mainfont", the value of the corresponding document metadata field is used. If unspecified, the sans font is used if that has been specified. Otherwise we fall back to the LaTeX default.

plot_font_options

given a plot_font, font options. if plot_font is "sansfont" or "mainfont", the corresponding font options will be used by default.

scuro

whether to apply the scuro color scheme to slides themselves.

Value

an R Markdown output format used by render.

See Also

The included lectures R Markdown template for supporting files and example source. In RStudio, choose "File > New File > R Markdown...", choose "From Template," and select "Dark-on-Light Beamer Slides."


agoldst/scuro documentation built on Nov. 5, 2021, 3:44 a.m.