FileRspResponse

Package: R.rsp 
Class FileRspResponse 
<code>Object</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspResponse</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>FileRspResponse</code> 
Directly known subclasses: 
HttpDaemonRspResponse 
public static class FileRspResponse 
extends RspResponse

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

FileRspResponse function

<dl> <dt>file</dt>
<dd>A filename or a <code><a href="/link/connection?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::connection">connection</a></code> to write responses to.</dd> <dt>path</dt>
<dd>An optional path to the file.</dd> <dt>overwrite</dt>
<dd>If <code><a href="/link/FALSE?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::FALSE">FALSE</a></code>, an error is thrown if the output file already
 exists, otherwise not.</dd> <dt>...</dt>
<dd>Not used.</dd></dl>

Arguments

Methods: <table class="table">
<tr><td></td><td><code>flush</code></td><td>-</td></tr>
<tr><td></td><td><code>getAbsolutePath</code></td><td>Gets the absolute pathname to the current RSP file.</td></tr>
<tr><td></td><td><code>getName</code></td><td>Gets the (base)name of the current RSP file.</td></tr>
<tr><td></td><td><code>getOutput</code></td><td>Gets the output for an RSP response.</td></tr>
<tr><td></td><td><code>getPath</code></td><td>Gets the path of the directory of the current RSP file.</td></tr>
<tr><td></td><td><code>writeResponse</code></td><td>-</td></tr>
</table>Methods inherited from RspResponse: 
flush, writeResponse
Methods inherited from Object: 
$, $&lt;-, [[, [[&lt;-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Fields and Methods

Author

Package: R.rsp 
Class FileRspResponse 
<code>Object</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspResponse</code> 
<code>~~~~~~~|</code> 
<code>~~~~~~~+--</code><code>FileRspResponse</code> 
Directly known subclasses: 
HttpDaemonRspResponse 
public static class FileRspResponse 
extends RspResponse

The FileRspResponse class — FileRspResponse

<dl>

 <dt>file</dt>
<dd>A filename or a <code><a href='https://rdrr.io/r/base/connections.html'>connection</a></code> to write responses to.</dd>

 <dt>path</dt>
<dd>An optional path to the file.</dd>

 <dt>overwrite</dt>
<dd>If <code><a href='https://rdrr.io/r/base/logical.html'>FALSE</a></code>, an error is thrown if the output file already
 exists, otherwise not.</dd>

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

</dl>

Methods: <table class='table'>
<tr><td></td><td><code>flush</code></td><td>-</td></tr>
<tr><td></td><td><code>getAbsolutePath</code></td><td>Gets the absolute pathname to the current RSP file.</td></tr>
<tr><td></td><td><code>getName</code></td><td>Gets the (base)name of the current RSP file.</td></tr>
<tr><td></td><td><code>getOutput</code></td><td>Gets the output for an RSP response.</td></tr>
<tr><td></td><td><code>getPath</code></td><td>Gets the path of the directory of the current RSP file.</td></tr>
<tr><td></td><td><code>writeResponse</code></td><td>-</td></tr>
</table>



Methods inherited from RspResponse: 
flush, writeResponse
Methods inherited from Object: 
$, $&lt;-, [[, [[&lt;-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

	`flush`	-
	`getAbsolutePath`	Gets the absolute pathname to the current RSP file.
	`getName`	Gets the (base)name of the current RSP file.
	`getOutput`	Gets the output for an RSP response.
	`getPath`	Gets the path of the directory of the current RSP file.
	`writeResponse`	-

FileRspResponse: The FileRspResponse class

Description

Usage

Arguments

Fields and Methods

Author