transform_param: Process @permitted and @default tags
In admiraldev: Utility Functions and Development Tools for the Admiral Package Family
transform_param R Documentation
Process @permitted and @default tags
Description
This function processes the @permitted and @default tags and moves them
into the @param tag. The default value is taken from the function call if
not specified.
Usage
transform_param(block, rdx_permitted_values)
Arguments
block
A block of roxygen tags of one function
- Default value
none
rdx_permitted_values
A list of permitted values
The name of the list item can be referenced in the @permitted tag by
specifying the name in square brackets, e.g., @permitted [mode].
- Default value
none
Value
The block with the transformed tags
admiraldev documentation built on June 26, 2025, 1:09 a.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.
| transform_param | R Documentation |
Process @permitted and @default tags
Description
This function processes the @permitted and @default tags and moves them
into the @param tag. The default value is taken from the function call if
not specified.
Usage
transform_param(block, rdx_permitted_values)
Arguments
block |
A block of roxygen tags of one function
|
rdx_permitted_values |
A list of permitted values The name of the list item can be referenced in the
|
Value
The block with the transformed tags
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.