In-Line Documentation for R

---

Documentation for package ‘roxygen2’ version 7.2.3

• DESCRIPTION file.
• User guides, package vignettes and other documentation.

Help Pages

@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 datasets and classes
@format	Tags for documenting datasets and classes
@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 datasets and classes
@noMd	Tags related to markdown support
@noRd	Tags for documenting functions
@order	Tags that help you reuse documentation
@param	Tags for documenting functions
@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 datasets and classes
@source	Tags for documenting datasets and classes
@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'
load	Load package code
load_installed	Load package code
load_pkgload	Load package code
load_source	Load package code
namespace_roclet	Roclet: make 'NAMESPACE'
rd_roclet	Roclet: make Rd files
roxygenise	Process a package with the Rd, namespace and collate roclets
roxygenize	Process a package with the Rd, namespace and collate roclets
tags-index-crossref	Tags for indexing and cross-references
tags-namespace	Tags for managing the 'NAMESPACE'
tags-rd	Tags for documenting functions
tags-rd-formatting	Tags related to markdown support
tags-rd-other	Tags for documenting datasets and classes
tags-reuse	Tags that help you reuse documentation
update_collate	Update Collate field in DESCRIPTION
vignette_roclet	Re-build outdated vignettes