buildVignette

Builds a vignette into a PDF or a HTML file.

internal

file

documentation

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

buildVignette function

<dl> <dt>file</dt>
<dd>A character string specifying the vignette source file.</dd> <dt>dir</dt>
<dd>A character string specifying the working directory.</dd> <dt>latex</dt>
<dd>A logical specifying whether a TeX produced by weave
 should be compiled by texi2pdf or not.</dd> <dt>tangle</dt>
<dd>A logical specifying whether tangle should be run or not.</dd> <dt>quiet</dt>
<dd>A logical specifying whether weave, texi2pdf, and
 tangle should be run in quiet mode or not.</dd> <dt>clean</dt>
<dd>Remove all files generated by the build, even if there
 were copies there before.</dd> <dt>engine</dt>
<dd>An optional <code><a href="/link/character?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::character">character</a></code> string specifying the vignette
 engine to use for building the vignette. If not specified, it will
 be inferred from the <code>\VignetteEngine{}</code> markup in the
 vignette. If that is not specified, the <code>"utils::Sweave"</code>
 engine will be used.</dd> <dt>buildPkg</dt>
<dd>An optional <code><a href="/link/character?package=R.rsp&version=0.46.0" data-mini-rdoc="R.rsp::character">character</a></code> string specifying the vignette
 package to use, if the vignette engine does not specify one.</dd> <dt>...</dt>
<dd>Additional arguments passed to weave and tangle.</dd></dl>

Arguments

Author

Builds a vignette — buildVignette

<dl>

 <dt>file</dt>
<dd>A character string specifying the vignette source file.</dd>

 <dt>dir</dt>
<dd>A character string specifying the working directory.</dd>

 <dt>latex</dt>
<dd>A logical specifying whether a TeX produced by weave
 should be compiled by texi2pdf or not.</dd>

 <dt>tangle</dt>
<dd>A logical specifying whether tangle should be run or not.</dd>

 <dt>quiet</dt>
<dd>A logical specifying whether weave, texi2pdf, and
 tangle should be run in quiet mode or not.</dd>

 <dt>clean</dt>
<dd>Remove all files generated by the build, even if there
 were copies there before.</dd>

 <dt>engine</dt>
<dd>An optional <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> string specifying the vignette
 engine to use for building the vignette. If not specified, it will
 be inferred from the <code>\VignetteEngine{}</code> markup in the
 vignette. If that is not specified, the <code>"utils::Sweave"</code>
 engine will be used.</dd>

 <dt>buildPkg</dt>
<dd>An optional <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> string specifying the vignette
 package to use, if the vignette engine does not specify one.</dd>

 <dt>...</dt>
<dd>Additional arguments passed to weave and tangle.</dd>

</dl>

buildVignette: Builds a vignette

Description

Usage

Value

Arguments

Author

See Also