SweaveListingPreparations: SweaveListingPreparations In SweaveListingUtils: Utilities for Sweave Together with TeX 'listings' Package

Description

helping tool for writing the corresponding TeX preamble commands to integrate Sweave and package listings

Usage

 ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22``` ```SweaveListingPreparations( withOwnFileSection = FALSE, withVerbatim = FALSE, withSchunkDef = TRUE, gin = TRUE, ae = TRUE, LineLength = getOption("width"), Rset = getSweaveListingOption("Rset"), Rdset = getSweaveListingOption("Rdset"), Rin = getSweaveListingOption("Rin"), Rout = getSweaveListingOption("Rout"), Rcode = getSweaveListingOption("Rcode"), Rcolor = getSweaveListingOption("Rcolor"), RRecomdcolor = getSweaveListingOption("RRecomdcolor"), Rbcolor = getSweaveListingOption("Rbcolor"), Routcolor = getSweaveListingOption("Routcolor"), Rcommentcolor = getSweaveListingOption("Rcommentcolor"), pkg = getSweaveListingOption("pkg"), pkv = getSweaveListingOption("pkv"), fileCommand = getSweaveListingOption("fileCommand"), pkgCommand = getSweaveListingOption("pkgCommand"), lib.loc = NULL) ```

Arguments

 `withOwnFileSection` logical: Does one want to use an own definition file/ section to define `Sinput`, `Soutput`, `Scode` environments; if `TRUE` you should write some \include directive to include your own definitions / or write them in your ‘.Rnw’ file. `withVerbatim` logical of length 3 (filled by recycling if of shorter length) either named ("Sinput", "Soutput", "Scode") or taken in order (Sinput, Soutput, Scode): Should we use Verbatim from TeX package 'fancyvrb' (i.e. the original "\DefineVerbatimEnvironment{Sinput}{Verbatim}" by Fritz Leisch) or just TeX package 'listings' (i.e. we define our own `Sinput` environment based on 'listings' command 'lstnewenvironment'; this option is due to a suggestion by Andrew Ellis (thank you!). `withSchunkDef` logical: shall environment `Schunk` be defined? `gin` logical: shall we use `gin` `ae` logical: shall we use `ae` `LineLength` numeric; defaults to 80 `Rset` list or taglist; defaults to global option `"Rset"` `Rdset` list or taglist; defaults to global option `"Rdset"` `Rin` list or taglist; format string for R input code; defaults to global option `"Rin"` `Rout` list or taglist; format string for R output code; defaults to global option `"Rout"` `Rcode` list or taglist; format string for R code; defaults to global option `"Rcode"` `Rcolor` numeric of length 3; [color for R-input-code] defaults to global option `"Rcolor"`; rgb coordinates of the color in which to print R-code `RRecomdcolor` numeric of length 3; [color for R-symbols from recommended packages] defaults to global option `"RRecomdcolor"`; rgb coordinates of the color in which to print R-code `Rbcolor` numeric of length 3; [color for R-symbols from intermediate packages] defaults to global option `"Rbcolor"`; rgb coordinates of the color in which to print R keywords induced by intermediate packages. `Routcolor` numeric of length 3; [color for R-output-code] defaults to global option `"Rout"`; rgb coordinates of the color in which to print R output `Rcommentcolor` numeric of length 3; [color for R-comments] defaults to global option `"Rcomment"`; rgb coordinates of the color in which to print comments in R-code `pkg` character; name of the packageto be described (e.g. in a vignette); defaults to global option `"pkg"` `pkv` character; package version to be described (e.g. in a vignette); defaults to global option `"pkv"` `fileCommand` character; the TeX code to define TeX command `\file` `pkgCommand` character; the TeX code to define TeX command `\pkg` `lib.loc` location of a local library in which the described package resides

Details

`SweaveListingPreparations` writes a corresponding preamble to the ‘.Rnw’-file for the simultaneous use of Sweave and package listings; note that so far, even if you do not want to use the default style file ‘Sweave.sty’, the lines

 ```1 2``` ```%\usepackage{Sweave} \SweaveOpts{keep.source=TRUE} ```

still have to appear in the ‘.Rnw’ file — before the corresponding `SweaveListingPreparations`-chunk.
The TeX code inserted by `SweaveListingPreparations` sets colors, requires TeX-package ‘listings’, defines listings-settings for ‘.R’- and ‘.Rd’-code. For ‘.Rd’ files it uses a new 'listings'-language definition file, ‘Rdlisting.sty’ to be found in subfolder ‘TeX’ in the SweaveListingUtils package folder. `SweaveListingPreparations` is to be called in an ‘.Rnw’ file and [re-]defines `Sinput`, `Soutput`, `Scode` environments for use with TeX-package ‘listings’, defines commands `\code`, `\file`, `\pkg` and sets the corresponding package version.
The default values are taken from SweaveListingOptions. The output to stdout can be captured in an ‘.Rnw’ file as

 ```1 2 3 4``` ```<< lstPreamble, results=tex, echo=FALSE>>= require(SweaveListingUtils) SweaveListingPreparations() @ ```

to insert the corresponding preamble parts to the produced TeX file.
If you one want to use destinct keywordstyles for packages loaded by `require` or `library` without adding extra arguments to these commands (and hence displaying the actual R code), you have to set up a global formatting matrix `.tobeDefinedPkgs` by `setToBeDefinedPkgs`.

Value

`invisible()`

Acknowledgement

The author wants to thank Frank E. Harrel and Andrew Ellis for very valuable suggestions to enhance this package.

Author(s)

Peter Ruckdeschel [email protected]

Examples

 ```1 2``` ```SweaveListingPreparations() SweaveListingPreparations(pkv="2.1") ```

SweaveListingUtils documentation built on May 30, 2017, 6:29 a.m.