update_collate

0th

Percentile

Update Collate field in DESCRIPTION.

Topologically sort R files and record in Collate field. The topological sort is based on the @include tag, which should specify the filenames (space separated) that should be loaded before the current file - these are typically necessary if you're using S4 or RC classes (because super classes must be defined before subclasses).

Usage
update_collate(base_path)
Arguments
base_path
Path to package directory.
Details

If there are no @include tags, roxygen2 will leave collate as is. This makes it easier to use roxygen2 with an existing collate directive, but if you remove all your @include tags, you'll need to also manually delete the collate field. This is not a roclet because roclets need the values of objects in a package, and those values can not be generated unless you've sourced the files, and you can't source the files unless you know the correct order.

Aliases
  • update_collate
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
NULL

## Not run: ------------------------------------
#   update_collate("my_package")
## ---------------------------------------------
Documentation reproduced from package roxygen2, version 5.0.1, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.