R.rsp (version 0.15.0)

R.rsp-package: Package R.rsp

Description

The RSP markup language makes any text-based document come alive. RSP provides a powerful markup for controlling the content and output of LaTeX, HTML, Markdown, AsciiDoc, Sweave and knitr documents (and more), e.g. 'Today's date is <%=sys.date()%>'. Contrary to many other literate programming languages, with RSP it is straightforward to loop over mixtures of code and text sections, e.g. in month-by-month summaries. RSP has also several preprocessing directives for incorporating static and dynamic contents of external files (local or online) among other things. Functions rstring() and rcat() make it easy to process RSP strings, while rfile() compiles RSP files (also online) into their final outputs, e.g. rfile('report.tex.rsp') generates 'report.pdf'. RSP is ideal for self-contained scientific reports and R package vignettes.

Installation

To install this package, call install.packages("R.rsp").

To get started

To get started, see:

1. For a detailed description of RSP, see vignette '../doc/index.html{Dynamic document creation using RSP}'.
2. For a quick overview of RSP, see vignette '../doc/index.html{Introductory slides on RSP}'.
3. For a one-page overview of RSP, see vignette '../doc/index.html{RSP Markup Language - Reference Card}'.
4. To included RSP vignettes in a package, see '../doc/index.html{Include RSP and other non-Sweave vignettes in R packages}'.
5. To compile a RSP-embedded text document to a final document, userfile(), e.g.rfile("report.tex.rsp")outputs file 'report.pdf' andrfile("report.md.rsp")outputs file 'report.html'.
6. To compile a RSP document (file or string) and output the result to standard output or a string, usercat() anrstring(), respectively.

Acknowledgments

Several of the post-processing features of this package utilize packages such as base64enc, ascii, knitr, and markdown. Not enough credit can be given to the authors and contributors of those packages. Thank you for your great work.

License

The releases of this package is licensed under LGPL version 2.1 or newer.

The development code of the packages is under a private licence (where applicable) and patches sent to the author fall under the latter license, but will be, if incorporated, released under the "release" license above.

How to cite this package

Bengtsson H (2014). R.rsp: Dynamic generation of scientific reports. R package version 0.14.1.