Package index • 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
tags_list() tags_metadata(): Access metadata about built-in or available tags

Running roxygen2

roxygenize() roxygenise(): Document a package with roxygen2
needs_roxygenize(): Check if documentation needs to be updated
load_pkgload() load_installed() load_source(): Load package code

Roclets

A roclet is roxygen2’s plugin system for processing documentation comments. Each roclet handles a different type of output.

namespace_roclet(): Roclet: make NAMESPACE
rd_roclet(): Roclet: make Rd files
update_collate(): Update Collate field in DESCRIPTION

Developing/extending roxygen2

load_options() roxy_meta_get(): Load roxygen2 options
parse_package() parse_file() parse_text() env_file() env_package(): Parse a package, file, or inline code
rd_section(): Construct an rd_section object
roc_proc_text(): Process roclet on string and capture results
roclet_find(): Create a roclet from a string
roxy_block() block_has_tags() block_get_tags() block_get_tag() block_get_tag_value(): Blocks
roxy_tag() roxy_tag_parse() roxy_tag_warning() warn_roxy_tag(): roxy_tag S3 constructor
roxy_tag_rd(): Generate Rd output from a tag
tag_value() tag_inherit() tag_name() tag_two_part() tag_name_description() tag_words() tag_words_line() tag_toggle() tag_code() tag_examples() tag_markdown() tag_markdown_with_sections(): Parse tags
tags_list() tags_metadata(): Access metadata about built-in or available tags