RspComment

Package: R.rsp 
Class RspComment 
<code>character</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspConstruct</code> 
<code>~~~~~~~~~~~~|</code> 
<code>~~~~~~~~~~~~+--</code><code>RspComment</code> 
Directly known subclasses: 
 
public class RspComment 
extends RspConstruct 
An RspComment is an <code>RspConstruct</code> that represents an RSP comment,
 which are of format <code>&lt;%-- ... --%&gt;</code>, <code>&lt;%--- ... ---%&gt;</code>
 and so on. They can also be so called "empty" RSP comments of format
 <code>&lt;%-%&gt;</code>, <code>&lt;%--%&gt;</code>, <code>&lt;%---%&gt;</code> and so on.

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

RspComment function

<dl> <dt>str</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>...</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>getComment</code></td><td>Gets the comment.</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, formula, getDLLRegisteredRoutines, glyphJust, isOpen, toLatex, uses

Fields and Methods

Author

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


An RspComment is an <code>RspConstruct</code> that represents an RSP comment,
 which are of format <code>&lt;%-- ... --%&gt;</code>, <code>&lt;%--- ... ---%&gt;</code>
 and so on. They can also be so called "empty" RSP comments of format
 <code>&lt;%-%&gt;</code>, <code>&lt;%--%&gt;</code>, <code>&lt;%---%&gt;</code> and so on.

The RspComment class — RspComment

<dl>

 <dt>str</dt>
<dd>A <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> string.</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>getComment</code></td><td>Gets the comment.</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, formula, getDLLRegisteredRoutines, glyphJust, isOpen, toLatex, uses

RspComment: The RspComment class

Description

Usage

Arguments

Fields and Methods

Author

	`asRspString`	-
	`getComment`	Gets the comment.