RspText

Package: R.rsp 
Class RspText 
<code>character</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspConstruct</code> 
<code>~~~~~~~~~~~~|</code> 
<code>~~~~~~~~~~~~+--</code><code>RspText</code> 
Directly known subclasses: 
 
public class RspText 
extends RspConstruct 
An RspText is an <code>RspConstruct</code> that represents a plain text
 section, i.e. everything that is inbetween any other types of
 <code>RspConstruct</code>:s.
 Its content is independent of the underlying programming language.

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

RspText function

<dl> <dt>text</dt>
<dd>A <code><a href="/link/character?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::character">character</a></code> string.</dd> <dt>escape</dt>
<dd>If <code><a href="/link/TRUE?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::TRUE">TRUE</a></code>, character sequences <code>&lt;%</code> and <code>%&gt;</code>
 are escaped to <code>&lt;%%</code> and <code>%%&gt;</code>.</dd> <dt>...</dt>
<dd>Not used.</dd></dl>

Arguments

Methods: <table class="table">
<tr><td></td><td><code>asRspString</code></td><td>-</td></tr>
<tr><td></td><td><code>getContent</code></td><td>Gets the contents of the RSP text.</td></tr>
<tr><td></td><td><code>getInclude</code></td><td>-</td></tr>
</table>Methods inherited from RspConstruct: 
asRspString, getComment, getInclude, getSuffixSpecs
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 RspText 
<code>character</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspConstruct</code> 
<code>~~~~~~~~~~~~|</code> 
<code>~~~~~~~~~~~~+--</code><code>RspText</code> 
Directly known subclasses: 
 
public class RspText 
extends RspConstruct 


An RspText is an <code>RspConstruct</code> that represents a plain text
 section, i.e. everything that is inbetween any other types of
 <code>RspConstruct</code>:s.
 Its content is independent of the underlying programming language.

The RspText class — RspText

<dl>

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

 <dt>escape</dt>
<dd>If <code><a href='https://rdrr.io/r/base/logical.html'>TRUE</a></code>, character sequences <code>&lt;%</code> and <code>%&gt;</code>
 are escaped to <code>&lt;%%</code> and <code>%%&gt;</code>.</dd>

 <dt>...</dt>
<dd>Not used.</dd>

</dl>

Methods: <table class='table'>
<tr><td></td><td><code>asRspString</code></td><td>-</td></tr>
<tr><td></td><td><code>getContent</code></td><td>Gets the contents of the RSP text.</td></tr>
<tr><td></td><td><code>getInclude</code></td><td>-</td></tr>
</table>



Methods inherited from RspConstruct: 
asRspString, getComment, getInclude, getSuffixSpecs
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

	`asRspString`	-
	`getContent`	Gets the contents of the RSP text.
	`getInclude`	-

RspText: The RspText class

Description

Usage

Arguments

Fields and Methods

Author