tags-rd-R6: Tags for documenting R6
In roxygen2: In-Line Documentation for R
tags-rd-R6 R Documentation
Tags for documenting R6
Description
Learn the full details in vignette('rd-R6').
Key tags:
-
@field ${1:name} ${2:description}: Describe a R6 or refClass field.
-
@R6method ${1:Class}$${2:method}: Document an R6 method that can't be discovered by introspection, such as methods added via $set().
Usage
#' @field ${1:name} ${2:description}
#' @R6method ${1:Class}$${2:method}
See Also
Other documentation tags:
tags-index-crossref,
tags-rd-S3,
tags-rd-S4,
tags-rd-S7,
tags-rd-datasets,
tags-rd-functions,
tags-reuse
roxygen2 documentation built on May 1, 2026, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| tags-rd-R6 | R Documentation |
Tags for documenting R6
Description
Learn the full details in vignette('rd-R6').
Key tags:
-
@field ${1:name} ${2:description}: Describe a R6 or refClass field. -
@R6method ${1:Class}$${2:method}: Document an R6 method that can't be discovered by introspection, such as methods added via$set().
Usage
#' @field ${1:name} ${2:description}
#' @R6method ${1:Class}$${2:method}
See Also
Other documentation tags:
tags-index-crossref,
tags-rd-S3,
tags-rd-S4,
tags-rd-S7,
tags-rd-datasets,
tags-rd-functions,
tags-reuse
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.