noweave: Extract documentation from a noweb object

Description Usage Arguments Details Author(s) See Also Examples

View source: R/noweb.R

Description

Write a TeX file from a noweb source file.

Usage

1
noweave(file, out, indent=1, syntax=nowebSyntax, ...)

Arguments

file

an input file containing noweb code, or alternately an object of class noweb as created by the nwread function.

out

a file name on which to write the result. By default this will be the name of the input file with it's final suffix changed to ".tex".

indent

the amount to indent code chunks

syntax

a list defining the syntax rules for noweb

...

unused argments needed to match Sweave usage

Details

R code written using noweb is a mixture of Latex documentation and chunks of R code. The noweave command formats these into a TeX document which is designed to explain the code to a human. The notangle command writes out R files for the computer's use.

Author(s)

Terry Therneau

See Also

nwread, notangle

Examples

1
2
3
4
## Not run: 
 # Create the TeX file of documentation for the noweb library
 noweave("noweb.Rnw"
## End(Not run)

noweb documentation built on May 29, 2017, 7:54 p.m.