roxygen: Literate Programming in R

A Doxygen-like in-source documentation system for Rd, collation, namespace and callgraphs.

AuthorPeter Danenberg <pcd@roxygen.org>, Manuel Eugster <Manuel.Eugster@stat.uni-muenchen.de> with contributions from Hadley Wickham <hadley@rice.edu>
Date of publicationNone
MaintainerPeter Danenberg <pcd@roxygen.org>
LicenseGPL (>= 2)
Version0.1-3
http://roxygen.org

View on R-Forge

Man pages

assign.parent: Assign a variable in the parent environment when <<-...

caar: Composite car/cdr...

cadar: Composite car/cdr...

caddr: Composite car/cdr...

cadr: Composite car/cdr...

car: First element of a list...

cat.description: Print the field-value pair to a given file or standard out.

cdddr: Composite car/cdr...

cddr: Composite car/cdr...

cdr: Return elements after the first of a list.

Compose: Compose an arbitrary number of functions.

copy.dir: Recursively copy a directory thither; optionally unlinking...

Curry: Pre-specify a procedures named parameters, returning a new...

debug: Convenience function to print variable-value pairs.

description.dependencies: Gather a DESCRIPTION's dependencies from the...

DESCRIPTION.FILE: Whither to copy collate...

DOC.DIR: Whither to install docs...

expression.from.partitum: Extract the expression from the parse tree.

first.non.null: Find the first non-null argument.

guess.name: Pluck name from a hierarchy of candidates; viz.

Identity: Identity function.

include: Collate value parser...

INST.DIR: Whither to copy installables...

is.assignment: Whether the expression implies assignment by <-...

is.even: Is a number even?

is.function.definition: Whether the expression assigns function...

is.nil: Whether a list is empty.

is.null.string: Does the string contain no matter, but very well [:space:]?

is.odd: Is a number odd?

LINE.DELIMITER: Sequence that distinguishes roxygen comment from normal...

make.callgraph.roclet: Make a callgraph roclet which produces a static call graph...

make.collate.roclet: Make collate roclet which parses the given files;...

make.description.parser: Make a parser to parse DESCRIPTION files.

make.namespace.roclet: Make a namespace roclet which parses the given files and...

make.Rd2.roclet: New implementation of the Rd roclet; same functionality as...

make.Rd.roclet: Make an Rd roclet which parses the given files and, if...

make.roclet: Abstract roclet that serves as a rudimentary API.

MAN.DIR: Whither to copy Rds...

MATTER: Anti-anti-words...

NAMESPACE.FILE: Whither to copy namespace...

Negate: Negate a function; borrowed from...

nil: The empty list...

NIL.STRING: Analogue to the empty list...

noop.description: Description parser that does nothing...

nwords: Number of words a string contains.

pairwise: Combine a list into pairwise elements; lists should...

parse.assignee: Find the assignee of the expression...

parse.call: Parse a function call, paying special attention to...

parse.default: Default parser which simply emits the key and expression;...

parse.description: Parse description: the premier part of a roxygen block...

parse.description.file: Convenience function to call...

parse.description.text: Parse lines of text corresponding to a package DESCRIPTION...

parse.element: Parse a raw string containing key and expressions.

parse.error: Centrally formatted error; stopping execution...

parse.file: Parse a source file containing roxygen directives.

parse.files: Parse many files at one.

parse.formals: Find the formal arguments associated with a given...

parse.message: Centrally formatted message...

parse.name: Parse an element containing a single name and only a name;...

parse.name.description: Parse an element containing a mandatory name...

parse.preref: Resorts to the default parser but with a warning about the...

parser.default: Default parser-lookup; if key not found, return...

parse.ref: Parse either srcrefs, prerefs or pairs of the same.

parse.ref.list: Parse a preref/srcrefs pair...

parse.ref.preref: Parse a preref...

parse.refs: Parse each of a list of preref/srcref pairs.

parser.preref: Preref parser-lookup; defaults to parse...

parse.text: Text-parsing hack using tempfiles for more facility.

parse.toggle: Turn a binary element on; parameters are ignored.

parse.value: Parse an element with a mandatory value.

parse.warning: Centrally formatted warning...

preorder.flatten.expression: Flatten a nested expression into a list, preorderly.

preorder.walk.expression: Recursively walk an expression (as returned by parse) in...

preref.parsers: Preref parser table...

prerefs: Comment blocks (possibly null) that precede a file's...

R.DIR: Whence to copy source code...

Reduce.paste: Ad-hoc abstraction to paste processed list-elements together.

register.parser: Register a parser with a table...

register.parsers: Register many parsers at once.

register.preref.parser: Specifically register a preref parser...

register.preref.parsers: Register many preref parsers at once.

roxygen: No-op for sourceless files...

ROXYGEN.DIR: Whither to copy package...

roxygenize: Process a package with the Rd, namespace and collate roclets.

roxygen-package: Literate Programming in R

SPACE: Absence of words...

strcar: First word in a string.

strcdr: Words after first in a string.

strcons: Join two string.

strmap: Map through the words in a string, joining the mapped...

substr.regexpr: Actually do the substring representation that...

TAG.DELIMITER: Symbol that delimits tags.

trim: Trim [:space:] on both sides of a string.

trim.left: Trim [:space:] to the left of a string.

trim.right: Trim [:space:] to the right of a string.

word.ref: Find the nth word in a string.

zip: Zip n lists together into tuplets of...

zip.c: Zip using c.

zip.list: Zip using list.

Functions

a}}, \code{\\alias{b} Man page
aliases Man page
assign.parent Man page
author Man page
caar Man page
cadar Man page
caddr Man page
cadr Man page
callGraph Man page
callGraphDepth Man page
callGraphPrimitives Man page
car Man page
cat.description Man page
cdddr Man page
cddr Man page
cdr Man page
Compose Man page
concept Man page
copy.dir Man page
Curry Man page
debug Man page
description.dependencies Man page
DESCRIPTION.FILE Man page
DOC.DIR Man page
example Man page
examples Man page
export Man page
exportClass Man page
exportMethod Man page
exportPattern Man page
expression.from.partitum Man page
first.non.null Man page
guess.name Man page
Identity Man page
import Man page
importClassesFrom Man page
importFrom Man page
importMethodsFrom Man page
include Man page
INST.DIR Man page
is.assignment Man page
is.even Man page
is.function.definition Man page
is.nil Man page
is.null.string Man page
is.odd Man page
keywords Man page
LINE.DELIMITER Man page
make.callgraph.roclet Man page
make.collate.roclet Man page
make.description.parser Man page
make.namespace.roclet Man page
make.Rd2.roclet Man page
make.Rd.roclet Man page
make.roclet Man page
MAN.DIR Man page
MATTER Man page
name Man page
NAMESPACE.FILE Man page
Negate Man page
nil Man page
NIL.STRING Man page
noop.description Man page
nord Man page
note Man page
nwords Man page
pairwise Man page
parse.assignee Man page
parse.call Man page
parse.default Man page
parse.description Man page
parse.description.file Man page
parse.description.text Man page
parse.element Man page
parse.error Man page
parse.file Man page
parse.files Man page
parse.formals Man page
parse.message Man page
parse.name Man page
parse.name.description Man page
parse.preref Man page
parser.default Man page
parse.ref Man page
parse.ref.list Man page
parse.ref.preref Man page
parse.refs Man page
parse.ref.srcref Man page
parser.preref Man page
parse.text Man page
parse.toggle Man page
parse.value Man page
parse.warning Man page
preorder.flatten.expression Man page
preorder.walk.expression Man page
preref.parsers Man page
prerefs Man page
R.DIR Man page
rdname Man page
Reduce.paste Man page
references Man page
register.parser Man page
register.parsers Man page
register.preref.parser Man page
register.preref.parsers Man page
register.srcref.parser Man page
register.srcref.parsers Man page
return Man page
roxygen Man page
ROXYGEN.DIR Man page
roxygenize Man page
roxygen-package Man page
S3method Man page
seealso Man page
slot Man page
SPACE Man page
strcar Man page
strcdr Man page
strcons Man page
strmap Man page
substr.regexpr Man page
TAG.DELIMITER Man page
title Man page
trim Man page
trim.left Man page
trim.right Man page
usage Man page
word.ref Man page
zip Man page
zip.c Man page
zip.list Man page

Files

roxygen
roxygen/R
roxygen/R/roxygenize.R roxygen/R/parse.R roxygen/R/Rdtank.R roxygen/R/callgraph.R roxygen/R/description.R roxygen/R/list.R roxygen/R/Rd2.R roxygen/R/string.R roxygen/R/parseS4.R roxygen/R/collate.R roxygen/R/namespace.R roxygen/R/Rdapi.R roxygen/R/functional.R roxygen/R/Rdmerge.R roxygen/R/memoize.R roxygen/R/aaa.R roxygen/R/roxygen.R roxygen/R/roclet.R roxygen/R/Rd.R
roxygen/NAMESPACE
roxygen/tests
roxygen/tests/test-all.R
roxygen/inst
roxygen/inst/tests
roxygen/inst/tests/helper-roxygen.R
roxygen/inst/tests/collate
roxygen/inst/tests/collate/socks.R
roxygen/inst/tests/collate/belt.R
roxygen/inst/tests/collate/watch.R
roxygen/inst/tests/collate/pants.R
roxygen/inst/tests/collate/shoes.R
roxygen/inst/tests/collate/jacket.R
roxygen/inst/tests/collate/tie.R
roxygen/inst/tests/collate/undershorts.R
roxygen/inst/tests/collate/shirt.R
roxygen/inst/tests/test-Rd.R
roxygen/inst/tests/test-collate.R
roxygen/inst/tests/Rd-example-2.R
roxygen/inst/tests/Rd-example-1.R
roxygen/inst/tests/test-namespace.R
roxygen/inst/doc
roxygen/inst/doc/GSoC-idea.pdf
roxygen/inst/doc/GSoC-idea.tex
roxygen/inst/doc/hello-roxygen.R
roxygen/inst/doc/roxygen.Rnw
roxygen/inst/doc/index.html
roxygen/inst/doc/roxygen.pdf
roxygen/inst/doc/roxygen.bib
roxygen/inst/doc/parse.file-callgraph.pdf
roxygen/inst/doc/roxygenize-profile.txt
roxygen/inst/doc/Compose-callgraph.pdf
roxygen/inst/doc/pseudoprime
roxygen/inst/doc/pseudoprime/R
roxygen/inst/doc/pseudoprime/R/fermat.R
roxygen/inst/doc/pseudoprime/R/pseudoprime-package.R
roxygen/inst/doc/pseudoprime/R/pseudoprime.R
roxygen/inst/doc/pseudoprime/inst
roxygen/inst/doc/pseudoprime/inst/doc
roxygen/inst/doc/pseudoprime/inst/doc/fermat.test-callgraph.pdf
roxygen/inst/doc/pseudoprime/DESCRIPTION
roxygen/inst/doc/roxygenize-callgraph.pdf
roxygen/TODO
roxygen/DESCRIPTION
roxygen/README
roxygen/man
roxygen/man/parse.formals.Rd roxygen/man/parse.preref.Rd roxygen/man/Curry.Rd roxygen/man/make.collate.roclet.Rd roxygen/man/parser.preref.Rd roxygen/man/trim.left.Rd roxygen/man/parse.name.description.Rd roxygen/man/R.DIR.Rd roxygen/man/parse.refs.Rd roxygen/man/INST.DIR.Rd roxygen/man/parse.description.Rd roxygen/man/parse.call.Rd roxygen/man/parse.message.Rd roxygen/man/debug.Rd roxygen/man/parse.ref.list.Rd roxygen/man/MATTER.Rd roxygen/man/parser.default.Rd roxygen/man/include.Rd roxygen/man/parse.description.text.Rd roxygen/man/zip.list.Rd roxygen/man/NIL.STRING.Rd roxygen/man/make.namespace.roclet.Rd roxygen/man/parse.file.Rd roxygen/man/parse.default.Rd roxygen/man/expression.from.partitum.Rd roxygen/man/zip.c.Rd roxygen/man/is.null.string.Rd roxygen/man/parse.toggle.Rd roxygen/man/preorder.flatten.expression.Rd roxygen/man/cdddr.Rd roxygen/man/LINE.DELIMITER.Rd roxygen/man/caar.Rd roxygen/man/parse.files.Rd roxygen/man/parse.text.Rd roxygen/man/Reduce.paste.Rd roxygen/man/strmap.Rd roxygen/man/Identity.Rd roxygen/man/make.callgraph.roclet.Rd roxygen/man/is.even.Rd roxygen/man/trim.right.Rd roxygen/man/strcar.Rd roxygen/man/is.function.definition.Rd roxygen/man/make.roclet.Rd roxygen/man/substr.regexpr.Rd roxygen/man/make.Rd.roclet.Rd roxygen/man/DOC.DIR.Rd roxygen/man/caddr.Rd roxygen/man/parse.warning.Rd roxygen/man/Negate.Rd roxygen/man/SPACE.Rd roxygen/man/is.nil.Rd roxygen/man/ROXYGEN.DIR.Rd roxygen/man/car.Rd roxygen/man/parse.name.Rd roxygen/man/DESCRIPTION.FILE.Rd roxygen/man/parse.ref.Rd roxygen/man/nwords.Rd roxygen/man/first.non.null.Rd roxygen/man/cddr.Rd roxygen/man/parse.description.file.Rd roxygen/man/register.preref.parser.Rd roxygen/man/assign.parent.Rd roxygen/man/parse.ref.preref.Rd roxygen/man/word.ref.Rd roxygen/man/nil.Rd roxygen/man/cadr.Rd roxygen/man/parse.value.Rd roxygen/man/roxygen.Rd roxygen/man/pairwise.Rd roxygen/man/parse.element.Rd roxygen/man/make.Rd2.roclet.Rd roxygen/man/roxygenize.Rd roxygen/man/strcons.Rd roxygen/man/parse.assignee.Rd roxygen/man/preref.parsers.Rd roxygen/man/guess.name.Rd roxygen/man/prerefs.Rd roxygen/man/NAMESPACE.FILE.Rd roxygen/man/description.dependencies.Rd roxygen/man/cat.description.Rd roxygen/man/Compose.Rd roxygen/man/cdr.Rd roxygen/man/zip.Rd roxygen/man/parse.error.Rd roxygen/man/strcdr.Rd roxygen/man/cadar.Rd roxygen/man/noop.description.Rd roxygen/man/is.odd.Rd roxygen/man/roxygen-package.Rd roxygen/man/register.preref.parsers.Rd roxygen/man/trim.Rd roxygen/man/copy.dir.Rd roxygen/man/register.parser.Rd roxygen/man/register.parsers.Rd roxygen/man/preorder.walk.expression.Rd roxygen/man/TAG.DELIMITER.Rd roxygen/man/MAN.DIR.Rd roxygen/man/is.assignment.Rd roxygen/man/make.description.parser.Rd

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.