parseVignette

internal

file

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

parseVignette function

<dl> <dt>pathname</dt>
<dd>The Rnw file to be parsed.</dd> <dt>commentPrefix</dt>
<dd>A regular expression specifying the prefix
 pattern of vignette comments.</dd> <dt>final</dt>
<dd>If <code><a href="/link/TRUE?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::TRUE">TRUE</a></code>, the output PDF or HTML file is also located.</dd> <dt>source</dt>
<dd>If <code><a href="/link/TRUE?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::TRUE">TRUE</a></code>, the output R source code file is also located.</dd> <dt>maxLines</dt>
<dd>The maximum number of lines to scan.</dd> <dt>...</dt>
<dd>Not used.</dd></dl>

Arguments

Author

Parses an Rnw file — parseVignette

<dl>

 <dt>pathname</dt>
<dd>The Rnw file to be parsed.</dd>

 <dt>commentPrefix</dt>
<dd>A regular expression specifying the prefix
 pattern of vignette comments.</dd>

 <dt>final</dt>
<dd>If <code><a href='https://rdrr.io/r/base/logical.html'>TRUE</a></code>, the output PDF or HTML file is also located.</dd>

 <dt>source</dt>
<dd>If <code><a href='https://rdrr.io/r/base/logical.html'>TRUE</a></code>, the output R source code file is also located.</dd>

 <dt>maxLines</dt>
<dd>The maximum number of lines to scan.</dd>

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

</dl>

parseVignette: Parses an Rnw file

Description

Usage

Value

Arguments

Author