Description
R Templates for Reproducible Data Analyses.
Description
A collection of R Markdown templates for nicely structured, reproducible data analyses in R. The templates have embedded examples on how to write citations, footnotes, equations and use colored message/info boxes, how to cross-reference different parts/sections in the report, provide a nice table of contents (toc) with a References section and proper R session information as well as examples using DT tables and ggplot2 graphs. The bookdown Lite template theme supports code folding.
README.md
rtemps
My personal favourite R
templates for doing reproducible data analyses.
Available Themes
- United HTML Document: a bootstrap-based single R Markdown document
- Bookdown Lite: a single-paged bookdown-based document
Install
From CRAN:
install.packages("rtemps")
Note that the package imports among others the libraries DT, ggplot2 and xfun.
Usage
Once the templates are installed, you can use them in 2 ways:
- Within the templates in RStudio (highly advised - easiest way):
File
>New File
>R Markdown...
>From Template
(United HTML Theme)File
>New Project...
>New Directory
>Bookdown Lite project
(Bookdown Lite Theme)
- By calling the
create_rtemp()
function which allows you to create a new directory with all the template files inside, ready to be used/rendered.
Notes
United HTML Theme
- To create and render the template from an R session, run:
rtemps::create_rtemp(dirname = "new-dir", template = "united_html")
rmarkdown::render(input = "new-dir/index.Rmd", output_format = "html_document", output_dir = "new-dir")
Bookdown Lite Theme
- To create and render the template from the command line, run:
Rscript -e "rtemps::create_rtemp(dirname = 'new-dir', template = 'bookdown_lite')"
cd new-dir
./_build.sh
- The output of the Bookdown Lite theme is placed under a
docs
directory, so that it can easily be rendered with GitHub Pages. - The Bookdown Lite can be easily converted to a multi-paged document by configuring the
split_by
property in the_output.yml
template file (check the doc).