Literate Programming in R


[Up] [Top]

Documentation for package ‘roxygen’ version 0.1-2

Help Pages

A C D E F G I K L M N P R S T U W Z

-- --

roxygen-package Literate Programming in R

-- A --

aliases Make an Rd roclet which parses the given files and, if specified, populates...
assign.parent Assign a variable in the parent environment when <<-...
author Make an Rd roclet which parses the given files and, if specified, populates...

-- C --

caar Composite car/cdr...
cadar Composite car/cdr...
caddr Composite car/cdr...
cadr Composite car/cdr...
callGraph Make a callgraph roclet which produces a static call graph...
callGraphDepth Make a callgraph roclet which produces a static call graph...
callGraphPrimitives Make a callgraph roclet which produces a static call graph...
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.
concept Make an Rd roclet which parses the given files and, if specified, populates...
copy.dir Recursively copy a directory thither; optionally unlinking...
Curry Pre-specify a procedures named parameters, returning a new procedure.

-- D --

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...

-- E --

example Make an Rd roclet which parses the given files and, if specified, populates...
examples Make an Rd roclet which parses the given files and, if specified, populates...
export Make a namespace roclet which parses the given files and writes a list of...
exportClass Make a namespace roclet which parses the given files and writes a list of...
exportMethod Make a namespace roclet which parses the given files and writes a list of...
exportPattern Make a namespace roclet which parses the given files and writes a list of...
expression.from.partitum Extract the expression from the parse tree.

-- F --

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

-- G --

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

-- I --

Identity Identity function.
import Make a namespace roclet which parses the given files and writes a list of...
importClassesFrom Make a namespace roclet which parses the given files and writes a list of...
importFrom Make a namespace roclet which parses the given files and writes a list of...
importMethodsFrom Make a namespace roclet which parses the given files and writes a list of...
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?

-- K --

keywords Make an Rd roclet which parses the given files and, if specified, populates...

-- L --

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

-- M --

make.callgraph.roclet Make a callgraph roclet which produces a static call graph...
make.collate.roclet Make collate roclet which parses the given files; topologically...
make.description.parser Make a parser to parse DESCRIPTION files.
make.namespace.roclet Make a namespace roclet which parses the given files and writes a list of...
make.Rd.roclet Make an Rd roclet which parses the given files and, if specified, populates...
make.Rd2.roclet New implementation of the Rd roclet; same functionality as the original...
make.roclet Abstract roclet that serves as a rudimentary API.
MAN.DIR Whither to copy Rds...
MATTER Anti-anti-words...

-- N --

name Make an Rd roclet which parses the given files and, if specified, populates...
NAMESPACE.FILE Whither to copy namespace...
Negate Negate a function; borrowed from src/library/base/R/funprog...
nil The empty list...
NIL.STRING Analogue to the empty list...
noop.description Description parser that does nothing...
nord New implementation of the Rd roclet; same functionality as the original...
note Make an Rd roclet which parses the given files and, if specified, populates...
nwords Number of words a string contains.

-- P --

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 file.
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...
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.ref.srcref Parse a srcref...
parse.refs Parse each of a list of preref/srcref pairs.
parse.srcref By default, srcrefs are ignored; this parser returns nil.
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...
parser.default Default parser-lookup; if key not found, return...
parser.preref Preref parser-lookup; defaults to parse...
parser.srcref Srcref parser-lookup; defaults to parse...
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 expressions.

-- R --

R.DIR Whence to copy source code...
rdname New implementation of the Rd roclet; same functionality as the original...
Reduce.paste Ad-hoc abstraction to paste processed list-elements together.
references Make an Rd roclet which parses the given files and, if specified, populates...
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.
register.srcref.parser Specifically register a srcref parser...
register.srcref.parsers Register many srcref parsers at once.
return Make an Rd roclet which parses the given files and, if specified, populates...
roxygen No-op for sourceless files...
ROXYGEN.DIR Whither to copy package...
roxygenize Process a package with the Rd, namespace and collate roclets.

-- S --

S3method Make a namespace roclet which parses the given files and writes a list of...
seealso Make an Rd roclet which parses the given files and, if specified, populates...
slot New implementation of the Rd roclet; same functionality as the original...
SPACE Absence of words...
src.lines Extract the source code from parsed elements...
srcref.parsers Srcref parser table...
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...

-- T --

TAG.DELIMITER Symbol that delimits tags.
title Make an Rd roclet which parses the given files and, if specified, populates...
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.

-- U --

usage Make an Rd roclet which parses the given files and, if specified, populates...

-- W --

word.ref Find the nth word in a string.

-- Z --

zip Zip n lists together into tuplets of...
zip.c Zip using c.
zip.list Zip using list.