RspFileProduct

Package: R.rsp 
Class RspFileProduct 
<code>logical</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspProduct</code> 
<code>~~~~~~~~~~~~|</code> 
<code>~~~~~~~~~~~~+--</code><code>RspFileProduct</code> 
Directly known subclasses: 
 
public class RspFileProduct 
extends RspProduct 
An RspFileProduct is an <code>RspProduct</code> that represents an
 RSP product in form of a file, e.g. LaTeX, Sweave and knitr documents.

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

RspFileProduct function

<dl> <dt>pathname</dt>
<dd>An existing file.</dd> <dt>...</dt>
<dd>Additional arguments passed to <code>RspProduct</code>.</dd> <dt>mustExist</dt>
<dd>If <code><a href="/link/TRUE?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::TRUE">TRUE</a></code>, it is asserted that the file exists.</dd></dl>

Arguments

Methods: <table class="table">
<tr><td></td><td><code>findProcessor</code></td><td>-</td></tr>
<tr><td></td><td><code>getFileSize</code></td><td>-</td></tr>
<tr><td></td><td><code>getType</code></td><td>-</td></tr>
<tr><td></td><td><code>print</code></td><td>-</td></tr>
<tr><td></td><td><code>view</code></td><td>-</td></tr>
</table>Methods inherited from RspProduct: 
!, findProcessor, getType, hasProcessor, print, process, view
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 RspFileProduct 
<code>logical</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspObject</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>RspProduct</code> 
<code>~~~~~~~~~~~~|</code> 
<code>~~~~~~~~~~~~+--</code><code>RspFileProduct</code> 
Directly known subclasses: 
 
public class RspFileProduct 
extends RspProduct 


An RspFileProduct is an <code>RspProduct</code> that represents an
 RSP product in form of a file, e.g. LaTeX, Sweave and knitr documents.

The RspFileProduct class — RspFileProduct

<dl>

 <dt>pathname</dt>
<dd>An existing file.</dd>

 <dt>...</dt>
<dd>Additional arguments passed to <code>RspProduct</code>.</dd>

 <dt>mustExist</dt>
<dd>If <code><a href='https://rdrr.io/r/base/logical.html'>TRUE</a></code>, it is asserted that the file exists.</dd>

</dl>

Methods: <table class='table'>
<tr><td></td><td><code>findProcessor</code></td><td>-</td></tr>
<tr><td></td><td><code>getFileSize</code></td><td>-</td></tr>
<tr><td></td><td><code>getType</code></td><td>-</td></tr>
<tr><td></td><td><code>print</code></td><td>-</td></tr>
<tr><td></td><td><code>view</code></td><td>-</td></tr>
</table>



Methods inherited from RspProduct: 
!, findProcessor, getType, hasProcessor, print, process, view
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`	-
	`getFileSize`	-
	`getType`	-
	`print`	-
	`view`	-

RspFileProduct: The RspFileProduct class

Description

Usage

Arguments

Fields and Methods

Author