In-Line Documentation for R

[Up] [Top]

Documentation for package ‘roxygen2’ version 8.0.0

Help Pages

B E L N P R T U W misc

-- B --

block_get_tag Blocks
block_get_tags Blocks
block_get_tag_value Blocks
block_has_tags Blocks

-- E --

env_file Parse a package, file, or inline code
env_package Parse a package, file, or inline code

-- L --

load Load package code
load_installed Load package code
load_options Load roxygen2 options
load_pkgload Load package code
load_source Load package code

-- N --

namespace_roclet Roclet: make 'NAMESPACE'
needs_roxygenize Check if documentation needs to be updated

-- P --

parse_file Parse a package, file, or inline code
parse_package Parse a package, file, or inline code
parse_text Parse a package, file, or inline code

-- R --

rd_roclet Roclet: make Rd files
rd_section Construct an 'rd_section' object
roclet_find Create a roclet from a string
roc_proc_text Process roclet on string and capture results
roxygenise Document a package with roxygen2
roxygenize Document a package with roxygen2
roxy_block Blocks
roxy_meta_get Load roxygen2 options
roxy_tag 'roxy_tag' S3 constructor
roxy_tag_parse 'roxy_tag' S3 constructor
roxy_tag_rd Generate Rd output from a tag
roxy_tag_warning 'roxy_tag' S3 constructor

-- T --

tags-index-crossref Tags for indexing and cross-references
tags-namespace Tags for managing the 'NAMESPACE'
tags-rd-datasets Tags for documenting datasets
tags-rd-formatting Tags related to markdown support
tags-rd-functions Tags for documenting functions
tags-rd-R6 Tags for documenting R6
tags-rd-S3 Tags for documenting S3
tags-rd-S4 Tags for documenting S4
tags-rd-S7 Tags for documenting S7
tags-reuse Tags that help you reuse documentation
tags_list Access metadata about built-in or available tags
tags_metadata Access metadata about built-in or available tags
tag_code Parse tags
tag_examples Parse tags
tag_inherit Parse tags
tag_markdown Parse tags
tag_markdown_with_sections Parse tags
tag_name Parse tags
tag_name_description Parse tags
tag_parsers Parse tags
tag_toggle Parse tags
tag_two_part Parse tags
tag_value Parse tags
tag_words Parse tags
tag_words_line Parse tags

-- U --

update_collate Update Collate field in DESCRIPTION

-- W --

warn_roxy_tag 'roxy_tag' S3 constructor

-- misc --

@aliases Tags for indexing and cross-references
@backref Tags for indexing and cross-references
@concept Tags for indexing and cross-references
@describeIn Tags that help you reuse documentation
@description Tags for documenting functions
@details Tags for documenting functions
@eval Tags that help you reuse documentation
@evalNamespace Tags for managing the 'NAMESPACE'
@evalRd Tags that help you reuse documentation
@example Tags for documenting functions
@examples Tags for documenting functions
@examplesIf Tags for documenting functions
@export Tags for managing the 'NAMESPACE'
@exportClass Tags for managing the 'NAMESPACE'
@exportMethod Tags for managing the 'NAMESPACE'
@exportPattern Tags for managing the 'NAMESPACE'
@exportS3Method Tags for managing the 'NAMESPACE'
@family Tags for indexing and cross-references
@field Tags for documenting R6
@format Tags for documenting datasets
@import Tags for managing the 'NAMESPACE'
@importClassesFrom Tags for managing the 'NAMESPACE'
@importFrom Tags for managing the 'NAMESPACE'
@importMethodsFrom Tags for managing the 'NAMESPACE'
@include Update Collate field in DESCRIPTION
@includeRmd Tags that help you reuse documentation
@inherit Tags that help you reuse documentation
@inheritDotParams Tags that help you reuse documentation
@inheritParams Tags that help you reuse documentation
@inheritSection Tags that help you reuse documentation
@keywords Tags for indexing and cross-references
@md Tags related to markdown support
@method Tags for documenting S3
@noMd Tags related to markdown support
@noRd Tags for documenting functions
@order Tags that help you reuse documentation
@param Tags for documenting functions
@prop Tags for documenting S7
@R6method Tags for documenting R6
@rawNamespace Tags for managing the 'NAMESPACE'
@rawRd Tags for documenting functions
@rdname Tags that help you reuse documentation
@references Tags for indexing and cross-references
@return Tags for documenting functions
@returns Tags for documenting functions
@section Tags related to markdown support
@seealso Tags for indexing and cross-references
@slot Tags for documenting S4
@source Tags for documenting datasets
@template Tags that help you reuse documentation
@templateVar Tags that help you reuse documentation
@title Tags for documenting functions
@usage Tags for documenting functions
@useDynLib Tags for managing the 'NAMESPACE'