RspString

Package: R.rsp 
Class RspString 
<code>character</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspString</code> 
Directly known subclasses: 
 
public class RspString 
extends RspObject 
An RspString is a <code><a href="/link/character?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::character">character</a></code> <code><a href="/link/vector?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::vector">vector</a></code> with RSP markup.

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

RspString function

<dl> <dt>s</dt>
<dd>A <code><a href="/link/character?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::character">character</a></code> <code><a href="/link/vector?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::vector">vector</a></code>.</dd> <dt>...</dt>
<dd>Arguments passed to <code>RspObject</code>.</dd></dl>

Arguments

Methods: <table class="table">
<tr><td></td><td><code>evaluate</code></td><td>Parses, translates, and evaluates the RSP string.</td></tr>
<tr><td></td><td><code>getSource</code></td><td>Gets the source reference of an RSP string.</td></tr>
<tr><td></td><td><code>getType</code></td><td>Gets the type of an RSP string.</td></tr>
<tr><td></td><td><code>nbrOfLines</code></td><td>Gets the number of lines in an RSP string.</td></tr>
<tr><td></td><td><code>parseDocument</code></td><td>Parses an RSP string into a RSP document.</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>toR</code></td><td>Parses and translates the RSP string into R code.</td></tr>
</table>Methods inherited from RspObject: 
print
Methods inherited from character: 
Ops,nonStructure,vector-method, Ops,structure,vector-method, Ops,vector,nonStructure-method, Ops,vector,structure-method, all.equal, as.Date, as.POSIXlt, as.data.frame, as.raster, coerce,ANY,character-method, coerce,character,SuperClassMethod-method, coerce,character,signature-method, coerce&lt;-,ObjectsWithPackage,character-method, coerce&lt;-,signature,character-method, downloadFile, formula, getDLLRegisteredRoutines, glyphJust, isOpen, toAsciiRegExprPattern, toFileListTree, toLatex, uses

Fields and Methods

Author

Package: R.rsp 
Class RspString 
<code>character</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspString</code> 
Directly known subclasses: 
 
public class RspString 
extends RspObject 


An RspString is a <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> <code><a href='https://rdrr.io/r/base/vector.html'>vector</a></code> with RSP markup.

The RspString class — RspString

<dl>

 <dt>s</dt>
<dd>A <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> <code><a href='https://rdrr.io/r/base/vector.html'>vector</a></code>.</dd>

 <dt>...</dt>
<dd>Arguments passed to <code>RspObject</code>.</dd>

</dl>

Methods: <table class='table'>
<tr><td></td><td><code>evaluate</code></td><td>Parses, translates, and evaluates the RSP string.</td></tr>
<tr><td></td><td><code>getSource</code></td><td>Gets the source reference of an RSP string.</td></tr>
<tr><td></td><td><code>getType</code></td><td>Gets the type of an RSP string.</td></tr>
<tr><td></td><td><code>nbrOfLines</code></td><td>Gets the number of lines in an RSP string.</td></tr>
<tr><td></td><td><code>parseDocument</code></td><td>Parses an RSP string into a RSP document.</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>toR</code></td><td>Parses and translates the RSP string into R code.</td></tr>
</table>



Methods inherited from RspObject: 
print
Methods inherited from character: 
Ops,nonStructure,vector-method, Ops,structure,vector-method, Ops,vector,nonStructure-method, Ops,vector,structure-method, all.equal, as.Date, as.POSIXlt, as.data.frame, as.raster, coerce,ANY,character-method, coerce,character,SuperClassMethod-method, coerce,character,signature-method, coerce&lt;-,ObjectsWithPackage,character-method, coerce&lt;-,signature,character-method, downloadFile, formula, getDLLRegisteredRoutines, glyphJust, isOpen, toAsciiRegExprPattern, toFileListTree, toLatex, uses

	`evaluate`	Parses, translates, and evaluates the RSP string.
	`getSource`	Gets the source reference of an RSP string.
	`getType`	Gets the type of an RSP string.
	`nbrOfLines`	Gets the number of lines in an RSP string.
	`parseDocument`	Parses an RSP string into a RSP document.
	`print`	-
	`rcat`	-
	`rclean`	-
	`rcode`	-
	`rcompile`	-
	`rfile`	-
	`rsource`	-
	`rstring`	-
	`toR`	Parses and translates the RSP string into R code.

RspString: The RspString class

Description

Usage

Arguments

Fields and Methods

Author