RspProduct

Package: R.rsp 
Class RspProduct 
<code>logical</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspProduct</code> 
Directly known subclasses: 
RspFileProduct, RspRSourceCode, RspShSourceCode, RspSourceCode, RspStringProduct 
public abstract class RspProduct 
extends RspObject 
An RspProduct object represents an RSP product generated by processing
 an RSP document.

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

RspProduct function

<dl> <dt>object</dt>
<dd>The RSP product.</dd> <dt>...</dt>
<dd>Arguments passed to <code>RspObject</code>.</dd></dl>

Arguments

Methods: <table class="table">
<tr><td></td><td><code>!</code></td><td>-</td></tr>
<tr><td></td><td><code>findProcessor</code></td><td>Locates a processor for an RSP product.</td></tr>
<tr><td></td><td><code>getType</code></td><td>Gets the type of an RSP product.</td></tr>
<tr><td></td><td><code>hasProcessor</code></td><td>Checks whether a processor exist or not for an RSP product.</td></tr>
<tr><td></td><td><code>print</code></td><td>-</td></tr>
<tr><td></td><td><code>process</code></td><td>Processes an RSP file product.</td></tr>
<tr><td></td><td><code>view</code></td><td>Views the RSP product.</td></tr>
</table>Methods inherited from RspObject: 
print
Methods inherited from logical: 
Ops,nonStructure,vector-method, Ops,structure,vector-method, Ops,vector,nonStructure-method, Ops,vector,structure-method, as.data.frame, as.raster, coerce,ANY,logical-method, whichVector

Fields and Methods

Author

Package: R.rsp 
Class RspProduct 
<code>logical</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspProduct</code> 
Directly known subclasses: 
RspFileProduct, RspRSourceCode, RspShSourceCode, RspSourceCode, RspStringProduct 
public abstract class RspProduct 
extends RspObject 


An RspProduct object represents an RSP product generated by processing
 an RSP document.

The RspProduct class — RspProduct

<dl>

 <dt>object</dt>
<dd>The RSP product.</dd>

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

</dl>

Methods: <table class='table'>
<tr><td></td><td><code>!</code></td><td>-</td></tr>
<tr><td></td><td><code>findProcessor</code></td><td>Locates a processor for an RSP product.</td></tr>
<tr><td></td><td><code>getType</code></td><td>Gets the type of an RSP product.</td></tr>
<tr><td></td><td><code>hasProcessor</code></td><td>Checks whether a processor exist or not for an RSP product.</td></tr>
<tr><td></td><td><code>print</code></td><td>-</td></tr>
<tr><td></td><td><code>process</code></td><td>Processes an RSP file product.</td></tr>
<tr><td></td><td><code>view</code></td><td>Views the RSP product.</td></tr>
</table>



Methods inherited from RspObject: 
print
Methods inherited from logical: 
Ops,nonStructure,vector-method, Ops,structure,vector-method, Ops,vector,nonStructure-method, Ops,vector,structure-method, as.data.frame, as.raster, coerce,ANY,logical-method, whichVector

	`!`	-
	`findProcessor`	Locates a processor for an RSP product.
	`getType`	Gets the type of an RSP product.
	`hasProcessor`	Checks whether a processor exist or not for an RSP product.
	`print`	-
	`process`	Processes an RSP file product.
	`view`	Views the RSP product.

RspProduct: The RspProduct class

Description

Usage

Arguments

Fields and Methods

Author