Installation
To install this package, call install.packages("R.rsp").To get started
We recommend that you start by reading one of the 'vignettes';
- A 5 minute slideshow covering the basics of RSP.
- Detailed description of the RSP markup language.
- A one-page RSP reference card.
- How to use RSP for package vignettes.
- How to use plain LaTeX for package vignettes.
- How to use static PDF or HTML package vignettes.
Then, when you're ready to try it yourself, these are commands you can start with:
- Play with
rcat(), which works like cat() but also processed RSP expressions, e.g. rcat("A random number: <%=sample(100, size="1)%">\n").
- To source a RSP document as you do with R scripts, use
rsource(), e.g. rsource("report.md.rsp") which will run the RSP and display the output as it appears.
- To compile a RSP document to a final document, use
rfile(), e.g. rfile("report.md.rsp") outputs Markdown file 'report.md' which is automatically compiled into a final 'report.html'.
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.