slots: @slot: document the slots of a S4 class.
In hadley/roxygen3: In-source documentation for R
Description
Details
Tag Usage
Slots
Description
Many S4 slots are considered internal implementation details, so slots
(unlike params) are not documented by default. You can use the @slot
and @autoSlots tags to document them. An example of the output is
include below.
Details
If a name but no description is provided for @slot, the description
will just contain a link to the documentation for the type of object that
goes in that slot. This is what is used for all slots if you use
@autoSlots.
Tag Usage
1
2
3
#' @slot name
#' @slot name description
#' @autoSlots
Slots
- slots
An object of class character
- classname
An object of class character
- text
An object of class character
- srcref
An object of class srcref (S3)
hadley/roxygen3 documentation built on May 17, 2019, 12:16 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.
Description Details Tag Usage Slots
Description
Many S4 slots are considered internal implementation details, so slots
(unlike params) are not documented by default. You can use the @slot
and @autoSlots tags to document them. An example of the output is
include below.
Details
If a name but no description is provided for @slot, the description
will just contain a link to the documentation for the type of object that
goes in that slot. This is what is used for all slots if you use
@autoSlots.
Tag Usage
1 2 3 | #' @slot name
#' @slot name description
#' @autoSlots
|
Slots
- slots
An object of class character
- classname
An object of class character
- text
An object of class character
- srcref
An object of class srcref (S3)
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.