rmdformats
usageThis 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.
The package provides two HTML output formats :
readthedown
formathtml_clean
formathtml_docco
formatChoose 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. create.doc()
gets two main arguments :
dirname
is the name of the folder and RMarkdown file to be createdformat
is the format name ("readthedown"
, "html_clean"
or "html_docco"
)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("mydocument.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
Some extra features are available depending on the format :
readthedown
is fully responsive, with collapsible navigationhtml_clean
and readthedown
provide an automatic and dynamic table of contentshtml_clean
and html_docco
provide automatic thumbnails for figures with lightbox displayThe package also provides 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.
Finally, it also provides the pilltabs()
helper function, which allows to display a crosstab dynamically. See one of the output samples for a live example.