rcompile.default

rcompile

rcompile.RspString

rcompile.RspDocument

<code><a rd-options="base" href="/link/character?package=R.rsp&version=0.40.0&to=base" data-mini-rdoc="base::character">character</a></code> strings with RSP markup.

Alternatively, a file, a URL or a <code><a rd-options="base:connections" href="/link/connection?package=R.rsp&version=0.40.0&to=base%3Aconnections" data-mini-rdoc="base:connections::connection">connection</a></code> from
     with the strings are read.
     If a file, the <code>path</code> is prepended to the file, iff given.

file, path

A <code><a rd-options="base" href="/link/character?package=R.rsp&version=0.40.0&to=base" data-mini-rdoc="base::character">character</a></code> string or a <code><a rd-options="base:connections" href="/link/connection?package=R.rsp&version=0.40.0&to=base%3Aconnections" data-mini-rdoc="base:connections::connection">connection</a></code> specifying where
     output should be directed.
     The default is a file with a filename where the input filename
     has been prepended by <code>compiled-</code> and saved
     in the directory given by the <code>workdir</code> argument.

output

The working directory to use after parsing and
     preprocessing.
     If argument <code>output</code> specifies an absolute pathname,
     then the directory of <code>output</code> is used, otherwise the
     current directory is used.

workdir

The <code><a rd-options="base" href="/link/environment?package=R.rsp&version=0.40.0&to=base" data-mini-rdoc="base::environment">environment</a></code> in which the RSP string is
     preprocessed and evaluated.

envir

A named <code><a rd-options="base" href="/link/list?package=R.rsp&version=0.40.0&to=base" data-mini-rdoc="base::list">list</a></code> of arguments assigned to the environment
    in which the RSP string is parsed and evaluated.
    See <code><a rd-options="R.utils" href="/link/cmdArgs?package=R.rsp&version=0.40.0&to=R.utils" data-mini-rdoc="R.utils::cmdArgs">cmdArgs</a></code>.

args

Specifies how far the compilation should proceed.

until

See <code><a rd-options="R.utils" href="/link/Verbose?package=R.rsp&version=0.40.0&to=R.utils" data-mini-rdoc="R.utils::Verbose">Verbose</a></code>.

verbose

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

rcompile function

<code><a rd-options='base' href='character'>character</a></code> strings with RSP markup.

Alternatively, a file, a URL or a <code><a rd-options='base:connections' href='connection'>connection</a></code> from
     with the strings are read.
     If a file, the <code>path</code> is prepended to the file, iff given.

A <code><a rd-options='base' href='character'>character</a></code> string or a <code><a rd-options='base:connections' href='connection'>connection</a></code> specifying where
     output should be directed.
     The default is a file with a filename where the input filename
     has been prepended by <code>compiled-</code> and saved
     in the directory given by the <code>workdir</code> argument.

The <code><a rd-options='base' href='environment'>environment</a></code> in which the RSP string is
     preprocessed and evaluated.

A named <code><a rd-options='base' href='list'>list</a></code> of arguments assigned to the environment
    in which the RSP string is parsed and evaluated.
    See <code><a rd-options='R.utils' href='cmdArgs'>cmdArgs</a></code>.

See <code><a rd-options='R.utils' href='Verbose'>Verbose</a></code>.

rcompile: Compiles an RSP document

Description

Usage

Arguments

Value

See Also