MakeSlideShow {BrailleR}R Documentation

Turn a set of Rmd files into an HTML slide show

Description

Takes a set of Rmd files in alphabetical order and makes them a set of linked HTML files or a single slidy presentation suitable for delivering a presentation., or a single plain HTML file suitable for distribution

Usage

MakeAllInOneSlide(Folder, Style = getOption("BrailleR.SlideStyle"), file=NULL)
MakeSlidy(Folder, file = NULL)
MakeSlideShow(Folder, Style = getOption("BrailleR.SlideStyle"), ContentsSlide = TRUE)

Arguments

Folder

name of the folder in the current working directory that contains the set of Rmd files.

Style

Choose the cascading style sheet file to be applied. The file is looked for in three places: Your MyBrailleR folder, the current working directory, and finally the folder with the Rmd files. The last one found is the one that gets used if multiple copies exist.

file

The filename to use for the Rmd and HTML files. These files will be overwritten if they already exist.

ContentsSlide

Do you want links for the extra slide that has links to all slides? The file will be called 00_Contents.html

Details

For MakeSlideShow: The files are temporarily moved up to the current working directory where the links for the back, next and optionally the contents slides are added, before these new files are knitted to HTML. The user then opens the first file in the set and has a series of next links to work with that gets them through the slide show. All temporary files are then deleted.

For MakeAllInOneSlide: The process is similar but the links are not added and only one HTML file is created.

Ultimately, the user should move to using the slidy presentation.

Value

A printout of the slides made in the order they will appear. The HTML files are in the current working directory.

Note

The official CRAN policies tell package developers that we cannot write files to the user's hard drive without their permission or notifying them that this is happening. Well, you've just been told. If you use this function, you will get files written to the hard drive on your computer, but you did want them.

Author(s)

A. Jonathan R. Godfrey


[Package BrailleR version 0.32.1 Index]