roxygen-package {roxygen} | R Documentation |
Roxygen is a Doxygen-like documentation system for R; allowing in-source specification of Rd files, collation and namespace directives.
Package: | Roxygen |
Type: | Package |
Version: | 0.1 |
Date: | 2008-08-25 |
License: | GPL (>= 2) |
LazyLoad: | yes |
Roxygen is run on a package (hereafter <package>) by
R CMD roxygen <package>
or Rcmd roxygen.sh <package>
on Windows. By default, it creates a directory ‘<package>.roxygen’
with the complete package cum populated Rd files, ‘NAMESPACE’, etc.;
but can also operate descructively on the package itself with the
-d option.
See the vignette (‘roxygen.pdf’) or manual (‘roxygen-manual.pdf’) for details.
Peter Danenberg pcd@roxygen.org, Manuel Eugster Manuel.Eugster@stat.uni-muenchen.de
Maintainer: Peter Danenberg pcd@roxygen.org
See make.Rd.roclet
,
make.namespace.roclet
,
make.collate.roclet
,
make.callgraph.roclet
for an overview of roxygen tags.
See roxygenize
for an alternative to `R CMD roxygen'.
## To process a package in `pkg', run `R CMD roxygen pkg'; or: ## Not run: roxygenize('pkg')