RweaveReST: A driver to parse sphinx noweb files with Sweave tool This...

In ascii: Export R Objects to Several Markup Languages

Description

A driver to parse sphinx noweb files with Sweave tool This driver parses sphinx files containing R code and replace pieces of code with their output.

RweaveReSTSetup

weaverReSTSetup

weaverReST

Usage

RweaveReST()

RweaveReSTSetup(
  file,
  syntax,
  output = NULL,
  quiet = FALSE,
  debug = FALSE,
  extension = "rst",
  backend = "docutils, sphinx, ...",
  openSchunk = ".. code-block:: r\n",
  closeSchunk = "\n\n",
  openSinput = "",
  closeSinput = "",
  openSoutput = "\n",
  closeSoutput = "",
  indent = "  ",
  openInclude = ".. include::",
  closeInclude = ".rst",
  openFig = ".. image:: ",
  closeFig = "",
  ...
)

weaverReSTSetup(
  file,
  syntax,
  output = NULL,
  quiet = FALSE,
  debug = FALSE,
  extension = "rst",
  backend = "docutils, sphinx, ...",
  openSchunk = ".. code-block:: r\n",
  closeSchunk = "\n\n",
  openSinput = "",
  closeSinput = "",
  openSoutput = "\n",
  closeSoutput = "",
  indent = "  ",
  openInclude = ".. include::",
  closeInclude = ".rst",
  openFig = ".. image:: ",
  closeFig = "",
  use.cache = TRUE,
  ...
)

weaverReST()

Arguments

file	file
syntax	syntax
output	output
quiet	quite
debug	debug
...	...
use.cache	use.cache
stylepath	stylepath

Value

None value is returned. From a .Rnw noweb file, the corresponding .rst is produced (as eventuals files for graphs).

Note

In order to work properly, noweb codes have to be located at the beginning of a line (no indentation).

Compare with RweaveLatex driver, RweaveReST provides one new option : format to choose the format of figure that will be inserted in the final document.

In addition, cache option from weaver package is also available with weaverReST driver.

A wrapper for Sweave can be used, named ReST.

Author(s)

David Hajage [e-mail]

See Also

Sweave, ReST

Examples

  ## Not run: 
ReST("file.Rnw")
  
## End(Not run)

ascii documentation built on Sept. 17, 2020, 5:07 p.m.