Function reference • roxygen2

Tags

tags-index-crossref @aliases @backref @concept @family @keywords @references @seealso: Tags for indexing and cross-references

tags-namespace @evalNamespace @export @exportClass @exportMethod @exportPattern @exportS3Method @import @importClassesFrom @importFrom @importMethodsFrom @rawNamespace @useDynLib: Tags for managing the NAMESPACE

tags-rd-formatting @md @noMd @section: Tags related to markdown support

tags-rd-other @field @format @method @slot @source: Tags for documenting datasets and classes

tags-rd @description @details @example @examples @examplesIf @noRd @param @rawRd @return @returns @title @usage: Tags for documenting functions

tags-reuse @describeIn @eval @evalRd @includeRmd @inherit @inheritDotParams @inheritParams @inheritSection @order @rdname @template @templateVar: Tags that help you reuse documentation

Running roxygen2

roxygenize() roxygenise(): Process a package with the Rd, namespace and collate roclets

update_collate(): Update Collate field in DESCRIPTION

load_pkgload() load_installed() load_source(): Load package code

Roclets

namespace_roclet(): Roclet: make NAMESPACE

rd_roclet(): Roclet: make Rd files