make.collate.roclet {roxygen}R Documentation

Make collate roclet which parses the given files; topologically...

Description

Make collate roclet which parses the given files; topologically sorting @includes, and either merging the Collate: directive with a pre-existing ‘DESCRIPTION’ or writing to standard out.

Usage

make.collate.roclet(merge.file, target.file, verbose=TRUE)

Arguments

merge.file DESCRIPTION’ file with which to merge directive; or NULL for none
target.file whither to cat directive (whether merged or not); blank line is standard out
verbose whether to describe what we're doing with the target.file

Details

Each @include tag should specify the filename of one intrapackage dependency; multiple @include tags may be given.

Contains the member function parse which parses an arbitrary number of files, and parse.dir which recursively parses a directory tree.

Value

Rd roclet

See Also

make.roclet

Examples

#' `example-a.R', `example-b.R' and `example-c.R' reside
#' in the `example' directory, with dependencies
#' a -> {b, c}. This is `example-a.R'.
#' @include example-b.R
#' @include example-c.R
roxygen()

roclet <- make.collate.roclet()
## Not run: roclet$parse.dir('example')

[Package roxygen version 0.1 Index]