This R package provides ready-to-use HTML output formats and templates for RMarkdown documents. The goal is to produce clean documents "out of the box", with or without the RStudio IDE.
For the moment, the package only provides one format, called html_clean
. It
is based on the bootstrap framework, with the following features :
- Clean and readable CSS styling
- Automatic and dynamic javascript table of contents
- Automatic thumbnails for figures with lightbox display
Sample outputs :
The package also provide a create.doc()
function as well as RStudio document
templates to easily generate an empty and ready to use RMarkdown file with
several configuration directives.
The package is not available on CRAN, but it is installable from Github :
library(devtools)
install_github("juba/rmdformats")
Choose File
> New File...
> R Markdown...
, then select From Template
.
You should then be able to create a new document from one of the package
templates.
The create.doc()
function allows you to create a new directory with a clean
ready-to-use RMarkdown file. crate.doc()
gets two main arguments :
dirname
is the name of the folder and RMarkdown file to be createdformat
is the format name (only"html_clean"
is available for now on)
By default, a Makefile
file will be created in the new folder for direct
rendering from the command line.
Rendering from within RStudio should be quite simple : just click the Knit
button.
You can render your document into HTML directly from within R with the
render()
function from the rmarkdown
package :
library(rmarkdown)
render('mydoc.Rmd)
If you created your .Rmd
file with the create.doc()
function, you can then
generate HTML or PDF files with :
make html
make pdf
You can also clean out any generated files and cache with make clean
.
- Tocify for the dynamic javascript table of contents
- Magnific popup lightbox plugin
- The code of
create.doc()
is heavily inspired by thecreate.project()
function of the ProjectTemplate package
The html_clean
styling and features are very similar to the ones from the great
knitrBootstrap package by Jim
Hester.