illinois-r / uiucthemes

RMarkdown Templates for UIUC Theme-Oriented Documents
https://illinois-r.github.io/uiucthemes/
Other
51 stars 12 forks source link
pandoc r rmarkdown rstudio uiuc

UIUC Themes for R Markdown (uiucthemes)

R build
status Package-License CRAN Version
Badge CRAN
Status CRAN RStudio mirror
downloads CRAN
status

The uiucthemes package includes a collection of UIUC-themed templates for presentations, journal articles, and exam templates.

Included in the package are:

Screenshots of each template are included in package overview vignette.

beamer_illinois - Example

Within an RMarkdown file, add the following:

---
title: '"Illinois" UIUC Beamer Theme'
short-title: "Beamer Slides"
author: "John and Mary Doe"
short-author: "J & M Doe"
date: 'August 19, 2021'      # Month DD, YYYY (Main Slide)
short-date: '08/19/2021' # MM/DD/YYYY (Lower Right)
institute: "University of Illinois at Urbana-Champaign"
short-institute: "UIUC"
department: "Department of Magic"                # Institute must be defined
license: "Did you license this slide deck? "
section-titles: false                            # Provides slide headings
safe-columns: true                               # Enables special latex macros for columns.
output: 
   uiucthemes::beamer_illinois
---

# Section title     
## Subsection title 

### Frame Title

Frame content 

**Unordered List**

- [University of Illinois at Urbana-Champaign (UIUC)](http://illinois.edu)
- [Department of Statistics](http://www.stat.illinois.edu/)
- [Illinois Informatics Institute](http://www.informatics.illinois.edu/)

*Ordered List*

1. <http://thecoatlessprofessor.com>
2. <https://github.com/coatless>

#### Title for block box

Content inside of a box 

### \LaTeX

\begin{exampleblock}{Binomial Theorem}
\begin{equation} 
  f\left(k\right) = \binom{n}{k} p^k\left(1-p\right)^{n-k}
  \label{eq:binom}
\end{equation} 
\end{exampleblock}

Hello Equation \ref{eq:binom}

This generates:

Materials Referenced

Prerequisites

Using uiucthemes from RStudio

To use uiucthemes from RStudio:

  1. Install the latest RStudio.

  2. Install the uiucthemes package:

install.packages(c("rmarkdown","uiucthemes"))
  1. Use the New R Markdown dialog to create an article from one of the templates:

New R
Markdown

Using uiucthemes outside of RStudio

  1. Install pandoc using the instructions for your platform.

  2. Install the rmarkdown and uiucthemes packages:

install.packages(c("rmarkdown","uiucthemes"))
  1. Use the rmarkdown::draft function to create articles:
rmarkdown::draft("slide_deck.Rmd", template = "beamer_illinois", package = "uiucthemes")

Using a development version of uiucthemes

To access the development version of uiucthemes, e.g. not on CRAN, please use:

if(!requireNamespace("remotes")) { install.packages("remotes") }
remotes::install_github("coatless/uiucthemes")

Authors

James Joseph Balamuta with contributions from Steven Andrew Culpepper, David Dalpiaz, and Jose Luis Rodriguez.

Citing the uiucthemes package

To ensure future development of the package, please cite uiucthemes package if used for a presentation. Citation information for the package may be acquired by using in R:

citation("uiucthemes")

License

MIT - James Joseph Balamuta