Package 'uiucthemes'

Title: 'R' 'Markdown' Themes for 'UIUC' Documents and Presentations
Description: A set of custom 'R' 'Markdown' templates for documents and presentations with the University of Illinois at Urbana-Champaign (UIUC) color scheme and identity standards.
Authors: James Balamuta [aut, cre] , Steven Andrew Culpepper [ctb] (Provided the Minimal Orange Beamer Theme), David Dalpiaz [ctb] (Collaborated on the LaTeX Journal Theme), Jose Luis Rodriguez [ctb] (Provided the Market Information Lab (MIL) Beamer Theme)
Maintainer: James Balamuta <[email protected]>
License: MIT + file LICENSE
Version: 0.3.2
Built: 2025-03-12 04:59:35 UTC
Source: https://github.com/illinois-r/uiucthemes

Help Index


uiucthemes: 'R' 'Markdown' Themes for 'UIUC' Documents and Presentations

Description

A set of custom 'R' 'Markdown' templates for documents and presentations with the University of Illinois at Urbana-Champaign (UIUC) color scheme and identity standards.

Details

Trial run on RMarkdown templates

Author(s)

Maintainer: James Balamuta [email protected] (ORCID)

Other contributors:

  • Steven Andrew Culpepper [email protected] (Provided the Minimal Orange Beamer Theme) [contributor]

  • David Dalpiaz [email protected] (Collaborated on the LaTeX Journal Theme) [contributor]

  • Jose Luis Rodriguez [email protected] (Provided the Market Information Lab (MIL) Beamer Theme) [contributor]

See Also

Useful links:


"Illinois" (UIUC) Themed Beamer Presentation Template for RMarkdown

Description

Generates from an RMarkdown file a Beamer presentation with "Illinois" (UIUC) colors and identity standards.

Usage

beamer_illinois(
  toc = FALSE,
  slide_level = 2,
  incremental = FALSE,
  fig_width = 10,
  fig_height = 7,
  fig_crop = TRUE,
  fig_caption = TRUE,
  dev = "pdf",
  df_print = "default",
  fonttheme = "default",
  highlight = "default",
  keep_tex = FALSE,
  latex_engine = "pdflatex",
  citation_package = c("default", "natbib", "biblatex"),
  includes = NULL,
  md_extensions = NULL,
  pandoc_args = NULL
)

Arguments

toc

TRUE to include a table of contents in the output (only level 1 headers will be included in the table of contents).

slide_level

The heading level which defines individual slides. By default this is the highest header level in the hierarchy that is followed immediately by content, and not another header, somewhere in the document. This default can be overridden by specifying an explicit slide_level.

incremental

TRUE to render slide bullets incrementally. Note that if you want to reverse the default incremental behavior for an individual bullet you can precede it with >. For example: > - Bullet Text

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.

fig_caption

TRUE to render figures with captions

dev

Graphics device to use for figure output (defaults to pdf)

df_print

Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of print, typically print.data.frame. The "kable" method uses the knitr::kable function. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the df_print behavior entirely by setting the option rmarkdown.df_print to FALSE. See Data frame printing section in bookdown book for examples.

fonttheme

Beamer font theme (e.g. "structurebold").

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.

keep_tex

Keep the intermediate tex file used in the conversion to PDF

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex" and "tectonic".

citation_package

The LaTeX package to process citations, natbib or biblatex. Use default if neither package is to be used, which means citations will be processed via the command pandoc-citeproc.

includes

Named list of additional content to include within the document (typically created using the includes function).

md_extensions

Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.

pandoc_args

Additional command line options to pass to pandoc

Value

A modified beamer_presentation based on the "Illinois" (UIUC) Beamer themed template.

Author(s)

James Joseph Balamuta (Theme Hooks and Beamer Template Modifications) See AUTHORS for more specific details behind each of the contributions.

Examples

## Not run: 
# Generate slide deck from beamer template
rmarkdown::draft("slide_deck.Rmd", template = "beamer_illinois", package = "uiucthemes")

# Compile the document
rmarkdown::render("slide_deck/slide_deck.Rmd")

## End(Not run)

Beamer Illinois Metropolis Template for RMarkdown

Description

Generates from an RMarkdown file a Beamer presentation with "Illinois" (UIUC) colors and identity standards based on the Metropolis theme.

Usage

beamer_imetropolis(
  toc = FALSE,
  slide_level = 3,
  incremental = FALSE,
  fig_width = 10,
  fig_height = 7,
  fig_crop = TRUE,
  fig_caption = TRUE,
  dev = "pdf",
  df_print = "default",
  fonttheme = "default",
  highlight = "default",
  keep_tex = FALSE,
  latex_engine = "pdflatex",
  citation_package = c("default", "natbib", "biblatex"),
  includes = NULL,
  md_extensions = NULL,
  pandoc_args = NULL
)

Arguments

toc

TRUE to include a table of contents in the output (only level 1 headers will be included in the table of contents).

slide_level

The heading level which defines individual slides. By default this is the highest header level in the hierarchy that is followed immediately by content, and not another header, somewhere in the document. This default can be overridden by specifying an explicit slide_level.

incremental

TRUE to render slide bullets incrementally. Note that if you want to reverse the default incremental behavior for an individual bullet you can precede it with >. For example: > - Bullet Text

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.

fig_caption

TRUE to render figures with captions

dev

Graphics device to use for figure output (defaults to pdf)

df_print

Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of print, typically print.data.frame. The "kable" method uses the knitr::kable function. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the df_print behavior entirely by setting the option rmarkdown.df_print to FALSE. See Data frame printing section in bookdown book for examples.

fonttheme

Beamer font theme (e.g. "structurebold").

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.

keep_tex

Keep the intermediate tex file used in the conversion to PDF

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex" and "tectonic".

citation_package

The LaTeX package to process citations, natbib or biblatex. Use default if neither package is to be used, which means citations will be processed via the command pandoc-citeproc.

includes

Named list of additional content to include within the document (typically created using the includes function).

md_extensions

Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.

pandoc_args

Additional command line options to pass to pandoc

Value

A modified beamer_presentation based on the "Illinois" (UIUC) Beamer themed template.

Author(s)

James Joseph Balamuta (Theme Hooks) See AUTHORS for more specific details behind each of the contributions.

Examples

## Not run: 
# Generate slide deck from beamer template
rmarkdown::draft("slide_deck.Rmd", template = "beamer_imetropolis", package = "uiucthemes")

# Compile the document
rmarkdown::render("slide_deck/slide_deck.Rmd")

## End(Not run)

Beamer Illinois Market Information Lab Presentation Template for RMarkdown

Description

Generates from an RMarkdown file a Beamer presentation with "marketlab" (UIUC) colors and identity standards with a focus on "Orange" and "White".

Usage

beamer_mil(
  toc = FALSE,
  slide_level = 3,
  incremental = FALSE,
  fig_width = 10,
  fig_height = 7,
  fig_crop = TRUE,
  fig_caption = TRUE,
  dev = "pdf",
  df_print = "default",
  fonttheme = "default",
  highlight = "default",
  keep_tex = FALSE,
  latex_engine = "pdflatex",
  citation_package = c("default", "natbib", "biblatex"),
  includes = NULL,
  md_extensions = NULL,
  pandoc_args = NULL
)

Arguments

toc

TRUE to include a table of contents in the output (only level 1 headers will be included in the table of contents).

slide_level

The heading level which defines individual slides. By default this is the highest header level in the hierarchy that is followed immediately by content, and not another header, somewhere in the document. This default can be overridden by specifying an explicit slide_level.

incremental

TRUE to render slide bullets incrementally. Note that if you want to reverse the default incremental behavior for an individual bullet you can precede it with >. For example: > - Bullet Text

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.

fig_caption

TRUE to render figures with captions

dev

Graphics device to use for figure output (defaults to pdf)

df_print

Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of print, typically print.data.frame. The "kable" method uses the knitr::kable function. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the df_print behavior entirely by setting the option rmarkdown.df_print to FALSE. See Data frame printing section in bookdown book for examples.

fonttheme

Beamer font theme (e.g. "structurebold").

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.

keep_tex

Keep the intermediate tex file used in the conversion to PDF

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex" and "tectonic".

citation_package

The LaTeX package to process citations, natbib or biblatex. Use default if neither package is to be used, which means citations will be processed via the command pandoc-citeproc.

includes

Named list of additional content to include within the document (typically created using the includes function).

md_extensions

Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.

pandoc_args

Additional command line options to pass to pandoc

Value

A modified beamer_presentation based on the "marketlab" (UIUC) Beamer themed template.

Author(s)

Jose Luis Rodriguez (Beamer Marketlab Theme) James Joseph Balamuta (Theme Hooks) See AUTHORS for more specific details behind each of the contributions.

Examples

## Not run: 
# Generate slide deck from beamer template
rmarkdown::draft("slide_deck.Rmd", template = "beamer_mil", package = "uiucthemes")

# Compile the document
rmarkdown::render("slide_deck/slide_deck.Rmd")

## End(Not run)

Beamer Illinois Orange Presentation Template for RMarkdown

Description

Generates from an RMarkdown file a Beamer presentation with "Illinois" (UIUC) colors and identity standards with a focus on "Orange" and "White".

Usage

beamer_orange(
  toc = FALSE,
  slide_level = 3,
  incremental = FALSE,
  fig_width = 10,
  fig_height = 7,
  fig_crop = TRUE,
  fig_caption = TRUE,
  dev = "pdf",
  df_print = "default",
  fonttheme = "default",
  highlight = "default",
  keep_tex = FALSE,
  latex_engine = "pdflatex",
  citation_package = c("default", "natbib", "biblatex"),
  includes = NULL,
  md_extensions = NULL,
  pandoc_args = NULL
)

Arguments

toc

TRUE to include a table of contents in the output (only level 1 headers will be included in the table of contents).

slide_level

The heading level which defines individual slides. By default this is the highest header level in the hierarchy that is followed immediately by content, and not another header, somewhere in the document. This default can be overridden by specifying an explicit slide_level.

incremental

TRUE to render slide bullets incrementally. Note that if you want to reverse the default incremental behavior for an individual bullet you can precede it with >. For example: > - Bullet Text

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.

fig_caption

TRUE to render figures with captions

dev

Graphics device to use for figure output (defaults to pdf)

df_print

Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of print, typically print.data.frame. The "kable" method uses the knitr::kable function. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the df_print behavior entirely by setting the option rmarkdown.df_print to FALSE. See Data frame printing section in bookdown book for examples.

fonttheme

Beamer font theme (e.g. "structurebold").

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.

keep_tex

Keep the intermediate tex file used in the conversion to PDF

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex" and "tectonic".

citation_package

The LaTeX package to process citations, natbib or biblatex. Use default if neither package is to be used, which means citations will be processed via the command pandoc-citeproc.

includes

Named list of additional content to include within the document (typically created using the includes function).

md_extensions

Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.

pandoc_args

Additional command line options to pass to pandoc

Value

A modified beamer_presentation based on the "Illinois" (UIUC) Beamer themed template.

Author(s)

Prof. Steven A Culpepper (Beamer Orange Theme) James Joseph Balamuta (Theme Hooks) See AUTHORS for more specific details behind each of the contributions.

Examples

## Not run: 
# Generate slide deck from beamer template
rmarkdown::draft("slide_deck.Rmd", template = "beamer_orange", package = "uiucthemes")

# Compile the document
rmarkdown::render("slide_deck/slide_deck.Rmd")

## End(Not run)

"Illinois" (UIUC) Metropolis themed HTML Template for RMarkdown

Description

Generates from an RMarkdown file an HTML presentation with "Illinois" (UIUC) colors and identity standards based on the Metropolis theme.

Usage

html_imetropolis(
  self_contained = FALSE,
  seal = TRUE,
  chakra = "https://remarkjs.com/downloads/remark-latest.min.js",
  nature = list(),
  ...
)

Arguments

self_contained

Whether to produce a self-contained HTML file by embedding all external resources into the HTML file. See the ‘Note’ section below.

seal

Whether to generate a title slide automatically using the YAML metadata of the R Markdown document (if FALSE, you should write the title slide by yourself).

chakra

A path to the remark.js library (can be either local or remote). Please note that if you use the default remote latest version of remark.js, your slides will not work when you do not have Internet access. They might also be broken after a newer version of remark.js is released. If these issues concern you, you should download remark.js locally (e.g., via summon_remark()), and use the local version instead.

nature

(Nature transformation) A list of configurations to be passed to remark.create(), e.g. list(ratio = '16:9', navigation = list(click = TRUE)); see https://github.com/gnab/remark/wiki/Configuration. Besides the options provided by remark.js, you can also set autoplay to a number (the number of milliseconds) so the slides will be played every autoplay milliseconds; alternatively, autoplay can be a list of the form list(interval = N, loop = TRUE), so the slides will go to the next page every N milliseconds, and optionally go back to the first page to restart the play when loop = TRUE. You can also set countdown to a number (the number of milliseconds) to include a countdown timer on each slide. If using autoplay, you can optionally set countdown to TRUE to include a countdown equal to autoplay. To alter the set of classes applied to the title slide, you can optionally set titleSlideClass to a vector of classes; the default is c("center", "middle", "inverse").

...

For tsukuyomi(), arguments passed to moon_reader(); for moon_reader(), arguments passed to rmarkdown::html_document().

Value

A modified xaringan::moon_reader() based on the "Illinois" (UIUC) Metropolis themed HTML template.

Author(s)

James Joseph Balamuta (Light Modifications of Metropolis and R function wrapper) See AUTHORS for more specific details behind each of the contributions.

Examples

## Not run: 
# Generate slide deck from beamer template
rmarkdown::draft("slide_deck.Rmd", template = "html_imetropolis", package = "uiucthemes")

# Compile the document
rmarkdown::render("slide_deck/slide_deck.Rmd")

## End(Not run)

UIUC Class Journal Format

Description

Modified version of the Journal of Statistical Software (JSS) Format for creating a Journal of Statistical Software (JSS) articles. Adapted from http://www.jstatsoft.org/about/submissions.

Usage

latex_journal_format(..., keep_tex = TRUE, citation_package = "natbib")

Arguments

...

Arguments to rmarkdown::pdf_document

keep_tex

Keep the intermediate tex file used in the conversion to PDF

citation_package

The LaTeX package to process citations, natbib or biblatex. Use default if neither package is to be used, which means citations will be processed via the command pandoc-citeproc.

Details

This format is largely based off of the rticles of jss_article.

Value

R Markdown output format to pass to render

Author(s)

JSS Editorial Staff for the Journal format, RStudio for jss_article, James Balamuta for the theme hook, and David Dalpiaz for skeleton content

References

rticles package by JJ Allaire, R Foundation, Hadley Wickham, Journal of Statistical Software, Yihui Xie, Ramnath Vaidyanathan, Association for Computing Machinery, Carl Boettiger, Elsevier, Karl Broman, Kirill Mueller, Bastiaan Quast, Randall Pruim, Ben Marwick, Charlotte Wickham, Oliver Keyes and Miao Yu (2017). rticles: Article Formats for R Markdown. R package version 0.4.1. https://CRAN.R-project.org/package=rticles

Examples

## Not run: 
library(rmarkdown)
draft("MyArticle.Rmd", template = "latex_journal_format", package = "uiucthemes")

## End(Not run)

Defunct functions in the uiucthemes package

Description

These functions have been removed from the uiucthemes package.

Usage

uiuc_beamer(...)

Arguments

...

All old parameters being passed into the function.

Details

uiuc_beamer has been removed in favor of beamer_illinois