uscimage template package

This package provides a set of wrappers to be used with rmarkdown in which personalized templates and configurations are set automatically to produce documents for the USC IMAGE project

Installation

Using devtools

devtools::install_github("USCBiostats/uscimage")

Example

For now, we have a template for beamer_presentation, which in our case is called beamer_USCImage. To use this with your Rmarkdown document, you simply need to set output: uscimage::beamer_USCImage. The simplest way of doing this is by replacing the output argument in the header of the rmd file. So instead of using beamer_presentation, we use uscimage::beamer_USCImage as the following example

---
title: "My fancy P01 Beamer presentation"
author: "George G. Vega Yon"
date: "October 5, 2017"
output: uscimage::beamer_USCImage
---

The next example shows this adding an extra option that is passed to rmarkdown::beamer_presentation, the includes option, and a couple of other arguments:

---
title: "My fancy P01 Beamer presentation"
short_title: "Fancy P01"
author: "George G. Vega Yon"
short_author: Vega Yon
date: "October 5, 2017"
institute:
  - Department of Preventive Medicine
  - University of Southern California
short_institute: USC
output:
  uscimage::beamer_USCImage:
    includes:
      in_header:
        \def\mytree{some code here}
---

Moreover, this package provides extra arguments that the current default beamer template does not hava:

1. short_title: Which allows passing the optional short title to \title[]{}

2. short_institute: Which allows passing the optional short institute names to \institute[]{}

3. short_author: Which allows passing the optional short authors to \author[]{}

An example can be seen in the compiled vignettes of the package.