Learn R Programming
⚠️There's a newer version (7.3.2) of this package.Take me there.

roxygen2 (version 2.0)

In-source documentation for R

Description

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

Copy Link

Version

Install

install.packages('roxygen2')

Monthly Downloads

188,795

Version

2.0

License

GPL (>= 2)

Maintainer

Hadley Wickham

Last Published

July 23rd, 2011

Functions in roxygen2 (2.0)

roxygen-package

Literate Programming in R
parse.value

Parse an element with a mandatory value.
rd_roclet

Roclet: make Rd files.
roc_proc

Process roclet and capture results.
parse.name.description

Parse an element containing a mandatory name and description (such as @param).
parse.unknown

Parse an unknown tag.
clear_caches

Clear all roxygen caches.
parse.file

Parse a source file containing roxygen directives.
register.preref.parser

Register parsers.
namespace_roclet

Roclet: make NAMESPACE.
roc_out

Process roclet and output results.
parse.files

Parse many files at once.
parse.name

Parse an element containing a single name and only a name.
register.preref.parsers

Register many parsers at once.
roc_proc_text

Process roclet on string and capture results. Useful for testing.
collate_roclet

Roclet: make Collate field in DESCRIPTION.
parse.text

Text-parsing hack using tempfiles for more facility.
new_roclet

Build new roclet object.
roxygenize

Process a package with the Rd, namespace and collate roclets.
parse.toggle

Turn a binary element on; parameters are ignored.
parse.default

Default parser which simply emits the key and expression.