RspLanguage

escape.HtmlRspLanguage

Package: R.rsp 
Class RspLanguage 
<code>Object</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspLanguage</code> 
Directly known subclasses: 
HtmlRspLanguage 
public static class RspLanguage 
extends Object 
An RspLanguage object specifies what the markup language of the
 response/output document is, e.g. plain text and HTML.
 The RspLanguage class provides methods to obtain language specific
 strings/output such as how newlines and comments are written.
 The RspLanguage class describes a plain text languages. For HTML
 see the <code>HtmlRspLanguage</code> subclass.

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

RspLanguage function

<dl> <dt>language</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>escape</code></td><td>Escapes a string specifically for a given RSP response language.</td></tr>
<tr><td></td><td><code>getComment</code></td><td>Gets a comment string specific for a given RSP response language.</td></tr>
<tr><td></td><td><code>getLanguage</code></td><td>Gets the language string.</td></tr>
<tr><td></td><td><code>getNewline</code></td><td>Gets the newline string specific for a given RSP response language.</td></tr>
<tr><td></td><td><code>getVerbatim</code></td><td>Gets a verbatim string specific for a given RSP response language.</td></tr>
</table>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 RspLanguage 
<code>Object</code> 
<code>~~|</code> 
<code>~~+--</code><code>RspLanguage</code> 
Directly known subclasses: 
HtmlRspLanguage 
public static class RspLanguage 
extends Object 


An RspLanguage object specifies what the markup language of the
 response/output document is, e.g. plain text and HTML.
 The RspLanguage class provides methods to obtain language specific
 strings/output such as how newlines and comments are written.
 The RspLanguage class describes a plain text languages. For HTML
 see the <code>HtmlRspLanguage</code> subclass.

The RspLanguage class — RspLanguage

<dl>

 <dt>language</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>escape</code></td><td>Escapes a string specifically for a given RSP response language.</td></tr>
<tr><td></td><td><code>getComment</code></td><td>Gets a comment string specific for a given RSP response language.</td></tr>
<tr><td></td><td><code>getLanguage</code></td><td>Gets the language string.</td></tr>
<tr><td></td><td><code>getNewline</code></td><td>Gets the newline string specific for a given RSP response language.</td></tr>
<tr><td></td><td><code>getVerbatim</code></td><td>Gets a verbatim string specific for a given RSP response language.</td></tr>
</table>



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

RspLanguage: The RspLanguage class

Description

Usage

Arguments

Fields and Methods

Author

	`escape`	Escapes a string specifically for a given RSP response language.
	`getComment`	Gets a comment string specific for a given RSP response language.
	`getLanguage`	Gets the language string.
	`getNewline`	Gets the newline string specific for a given RSP response language.
	`getVerbatim`	Gets a verbatim string specific for a given RSP response language.