afit_presentation: Create an AFIT Presentation

Description Usage Arguments Details Value Examples

Description

Format for converting from R Markdown to a slidy presentation.

Usage

1
2
3
4
5
6
afit_presentation(..., logo = NULL, template = "default.html",
  format = "afit_presentation", incremental = FALSE, fig_width = 8,
  fig_height = 4.9, self_contained = F, smart = FALSE, css = NULL,
  js = NULL, highlight = "default", pandoc_args = NULL, duration = NULL,
  footer = NULL, includes = NULL, mathjax = "default",
  font_adjustment = 0)

Arguments

...

extra stuff

logo

The file path for a image file shown on the title slide (relative to the .Rmd file)

template

The HTML template file

format

The type of template format type

incremental

Should bullets be revealed individually?

fig_width

The default figure width

fig_height

The default figure height

self_contained

How to handle resources

smart

Is this presentation smart

css

The file path for a css file (relative to the .Rmd file)

js

The file path for a js file (relative to the .Rmd file)

highlight

Code highlighting applied

pandoc_args

Arguments to apply to Pandoc

duration

Duration (in minutes) of the slide deck. This value is used to add a countdown timer to the slide footer.

footer

Footer text (e.g. organization name and/or copyright)

includes

Additional content to include using rmarkdown::includes

mathjax

Should mathjax be included

font_adjustment

Increase or decrease the default font size (e.g. -1 or +1). You can also manually adjust the font size during the presentation using the 'S' (smaller) and 'B' (bigger) keys.

Details

See the online documentation for additional details on using the slidy_presentation format.

For more information on markdown syntax for presentations see the pandoc online documentation.

Value

R Markdown output format to pass to render

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 

library(AFIT)

# simple invocation
render("afit_presentation.Rmd", slidy_presentation())

# specify an option for incremental rendering
render("afit_presentation.Rmd", slidy_presentation(incremental = TRUE))

## End(Not run)

Auburngrads/AFIT documentation built on May 5, 2019, 8:13 a.m.