compileMarkdown.default

compileMarkdown

The filename and (optional) path of the
     Markdown document to be compiled.

filename, path

Additional arguments passed to <code><a rd-options="markdown" href="/link/markdownToHTML?package=R.rsp&version=0.40.0&to=markdown" data-mini-rdoc="markdown::markdownToHTML">markdownToHTML</a></code>.

outPath

<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> <code><a rd-options="base" href="/link/vector?package=R.rsp&version=0.40.0&to=base" data-mini-rdoc="base::vector">vector</a></code> of valid HTML strings that should be added to the HTML <head> section.</head>

header

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> with meta data that will add as <meta> tags in the HTML <head> section.</head>

metadata

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

compileMarkdown function

Additional arguments passed to <code><a rd-options='markdown' href='markdownToHTML'>markdownToHTML</a></code>.

<code><a rd-options='base' href='character'>character</a></code> <code><a rd-options='base' href='vector'>vector</a></code> of valid HTML strings that should be added to the HTML <head> section.

A named <code><a rd-options='base' href='list'>list</a></code> with meta data that will add as <meta> tags in the HTML <head> section.

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

compileMarkdown: Compiles a Markdown file

Description

Usage

Arguments

Value

See Also