README.md

In Rapporter/rapport: A Report Templating System

rapport

rapport is an R package that facilitates creation of reproducible statistical report templates. Once created, rapport templates can be exported to various external formats: HTML, LaTeX, PDF, ODT, etc. Apart from R, all you need to know to start writing your own templates is pandoc markup syntax, and some rapport conventions that allow the reproducibility of the template.

Several predefined templates come bundled with default rapport installation, and their number will increase in future releases. Of course, we strongly encourage you to write your own templates, and/or customise the ones that are shipped with default package installation.

Installation

The most recent version of this package is hosted on GitHub, but we also submit stable versions to CRAN from time to time (read: once in a blue moon).

Build status:

• Development branch:
• Master branch:

We encourage everyone to install rapport via the nifty function from devtools package:

library(devtools)
install_github('rapport', 'rapporter')

Or download the sources in a zip file and build manually. To do so, please unzip the file to an empty dir and run the following commands there:

R CMD build rapport
R CMD INSTALL rapport_0.1.tar.gz

If you're running R on Windows, you need to install Rtools. Once you have installed Rtools, issue following command in command prompt:

R CMD build --binary <path to .tar.gz file>
R CMD INSTALL <path to .zip file>

Usage

For a brief introcution to rapport functionality, run:

demo(rapport)

Pages

For more info head over to package homepage.

Rapporter/rapport documentation built on April 14, 2021, 11:48 a.m.