RspDocument

A <code><a rd-options="base" href="/link/list?package=R.rsp&version=0.42.0&to=base" data-mini-rdoc="base::list">list</a></code> of <code><a rd-options="" href="/link/RspConstruct?package=R.rsp&version=0.42.0" data-mini-rdoc="R.rsp::RspConstruct">RspConstruct</a></code>:s and
 <code><a rd-options="" href="/link/RspDocument?package=R.rsp&version=0.42.0" data-mini-rdoc="R.rsp::RspDocument">RspDocument</a></code>:s.

expressions

Arguments passed to <code><a rd-options="" href="/link/RspObject?package=R.rsp&version=0.42.0" data-mini-rdoc="R.rsp::RspObject">RspObject</a></code>.

Package: R.rsp 
Class RspDocument<code>list</code>
<code>~~|</code>
<code>~~+--</code><code><a rd-options="R.rsp" href="/link/RspObject?package=R.rsp&version=0.42.0&to=R.rsp" data-mini-rdoc="R.rsp::RspObject">RspObject</a></code>
<code>~~~~~~~|</code>
<code>~~~~~~~+--</code><code>RspDocument</code>Directly known subclasses:
public class RspDocument
extends <a rd-options="R.rsp" href="/link/RspObject?package=R.rsp&version=0.42.0&to=R.rsp" data-mini-rdoc="R.rsp::RspObject">RspObject</a>An RspDocument represents a <code><a rd-options="base" href="/link/list?package=R.rsp&version=0.42.0&to=base" data-mini-rdoc="base::list">list</a></code> of <code><a rd-options="" href="/link/RspConstruct?package=R.rsp&version=0.42.0" data-mini-rdoc="R.rsp::RspConstruct">RspConstruct</a></code>:s.

classes

internal

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, rsource() sources an RSP file as it was an R script, while rfile() compiles it (even online) into its final output format, e.g. rfile('report.tex.rsp') generates 'report.pdf' and rfile('report.md.rsp') generates 'report.html'. RSP is ideal for self-contained scientific reports and R package vignettes. It's easy to use - if you know how to write an R script, you'll be up and running within minutes.

Henrik Bengtsson

R.rsp

Dynamic Generation of Scientific Reports

RspDocument function

Methods:<table><tr><td>
 </td>
<td> <code>[</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>[&lt;-</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>asRspString</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:dropEmptyText.RspDocument" href="/link/dropEmptyText?package=R.rsp&version=0.42.0&to=R.rsp%3AdropEmptyText.RspDocument" data-mini-rdoc="R.rsp:dropEmptyText.RspDocument::dropEmptyText">dropEmptyText</a></code> </td>
<td> Drops all empty RSP text constructs.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:evaluate.RspDocument" href="/link/evaluate?package=R.rsp&version=0.42.0&to=R.rsp%3Aevaluate.RspDocument" data-mini-rdoc="R.rsp:evaluate.RspDocument::evaluate">evaluate</a></code> </td>
<td> Parses, translates, and evaluates the RSP document.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:flatten.RspDocument" href="/link/flatten?package=R.rsp&version=0.42.0&to=R.rsp%3Aflatten.RspDocument" data-mini-rdoc="R.rsp:flatten.RspDocument::flatten">flatten</a></code> </td>
<td> Flattens an RspDocument.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:getPath.RspDocument" href="/link/getPath?package=R.rsp&version=0.42.0&to=R.rsp%3AgetPath.RspDocument" data-mini-rdoc="R.rsp:getPath.RspDocument::getPath">getPath</a></code> </td>
<td> Gets the path to the source reference of an RSP string.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:getSource.RspDocument" href="/link/getSource?package=R.rsp&version=0.42.0&to=R.rsp%3AgetSource.RspDocument" data-mini-rdoc="R.rsp:getSource.RspDocument::getSource">getSource</a></code> </td>
<td> Gets the source reference of an RSP document.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:getType.RspDocument" href="/link/getType?package=R.rsp&version=0.42.0&to=R.rsp%3AgetType.RspDocument" data-mini-rdoc="R.rsp:getType.RspDocument::getType">getType</a></code> </td>
<td> Gets the type of the RspDocument.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:mergeTexts.RspDocument" href="/link/mergeTexts?package=R.rsp&version=0.42.0&to=R.rsp%3AmergeTexts.RspDocument" data-mini-rdoc="R.rsp:mergeTexts.RspDocument::mergeTexts">mergeTexts</a></code> </td>
<td> Merge neighboring 'text' elements.</td>
</tr><tr><td>
 </td>
<td> <code>parseCutNPasteDirectives</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>parseIfElseDirectives</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:preprocess.RspDocument" href="/link/preprocess?package=R.rsp&version=0.42.0&to=R.rsp%3Apreprocess.RspDocument" data-mini-rdoc="R.rsp:preprocess.RspDocument::preprocess">preprocess</a></code> </td>
<td> Processes all RSP preprocessing directives.</td>
</tr><tr><td>
 </td>
<td> <code>print</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>rcat</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>rclean</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>rcode</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>rcompile</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>rfile</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>rsource</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code>rstring</code> </td>
<td> -</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:subset.RspDocument" href="/link/subset?package=R.rsp&version=0.42.0&to=R.rsp%3Asubset.RspDocument" data-mini-rdoc="R.rsp:subset.RspDocument::subset">subset</a></code> </td>
<td> Subsets an RspDocument.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:toR.RspDocument" href="/link/toR?package=R.rsp&version=0.42.0&to=R.rsp%3AtoR.RspDocument" data-mini-rdoc="R.rsp:toR.RspDocument::toR">toR</a></code> </td>
<td> Translates the RSP document into R source code.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:trim.RspDocument" href="/link/trim?package=R.rsp&version=0.42.0&to=R.rsp%3Atrim.RspDocument" data-mini-rdoc="R.rsp:trim.RspDocument::trim">trim</a></code> </td>
<td> Trims each of the RSP constructs.</td>
</tr><tr><td>
 </td>
<td> <code><a rd-options="R.rsp:trimNonText.RspDocument" href="/link/trimNonText?package=R.rsp&version=0.42.0&to=R.rsp%3AtrimNonText.RspDocument" data-mini-rdoc="R.rsp:trimNonText.RspDocument::trimNonText">trimNonText</a></code> </td>
<td> Trims all non-text RSP constructs.</td>
</tr></table>Methods inherited from RspObject:
print
Methods inherited from list:
all.equal, as.data.frame, attachLocally, relist, within

Fields and Methods

A <code><a rd-options='base' href='list'>list</a></code> of <code><a rd-options='' href='RspConstruct'>RspConstruct</a></code>:s and
 <code><a rd-options='' href='RspDocument'>RspDocument</a></code>:s.

Arguments passed to <code><a rd-options='' href='RspObject'>RspObject</a></code>.

	`[`	-
	`[<-`	-
	`asRspString`	-
	`dropEmptyText`	Drops all empty RSP text constructs.
	`evaluate`	Parses, translates, and evaluates the RSP document.
	`flatten`	Flattens an RspDocument.
	`getPath`	Gets the path to the source reference of an RSP string.
	`getSource`	Gets the source reference of an RSP document.
	`getType`	Gets the type of the RspDocument.
	`mergeTexts`	Merge neighboring 'text' elements.
	`parseCutNPasteDirectives`	-
	`parseIfElseDirectives`	-
	`preprocess`	Processes all RSP preprocessing directives.
	`print`	-
	`rcat`	-
	`rclean`	-
	`rcode`	-
	`rcompile`	-
	`rfile`	-
	`rsource`	-
	`rstring`	-
	`subset`	Subsets an RspDocument.
	`toR`	Translates the RSP document into R source code.
	`trim`	Trims each of the RSP constructs.
	`trimNonText`	Trims all non-text RSP constructs.

RspDocument: The RspDocument class

Description

Usage

Arguments

Fields and Methods