Training projects are projects where you need to produce materials for others and/or to produce slides.
createTrainingProject() aims to facilitate your training projects by setting up a best practices template project.
At the moment, this facility will set up a basic project with some additional folders:
If you make a
slides/ directory (both of which are created with the defaults), we will add
rmarkdown to the project’s DESCRIPTION file.
You can specify an alternative package for your handouts via
handoutEngine. At present, two additional package options are supported. The first is
bookdown, and the second is
tufte. If you select
tufte as the
handoutEngine, the relevant package will be added to the DESCRIPTION file and the demo files for this handout format will be added to the
You can also specify an alternative package for your slides via
slideEngine. The currently supported (most popular) package options are
xaringan. Note also that the default
slideEngine option (
rmarkdown) caters for a number of additional R Markdown presentation formats such as
beamer since these formats do not have additional package dependencies (although in the case of
beamer, you’ll need to have
TeX installed). If you are using RStudio, you can find R Markdown templates for these presentation formats by going to File -> New File -> R Markdown -> Presentation.
packrat argument is not supplied or is set to
TRUE, we will update the packrat manifest so that the packages are available when you open the project.