get_param_tag: Get the content of the @param tag
In admiraldev: Utility Functions and Development Tools for the Admiral Package Family
get_param_tag R Documentation
Get the content of the @param tag
Description
This function adds the permitted values and the default value to the
description of the @param tag. They are added as a definition list
(\describe{}).
Usage
get_param_tag(act_param, defaults)
Arguments
act_param
The content of the argument description to format
A list with three named elements is expected:
-
tag: The @param tag
-
permitted: The permitted values
-
default: The default value
- Default value
none
defaults
A list of default values from the function call
- Default value
none
Value
The formatted @param tag
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.
| get_param_tag | R Documentation |
Get the content of the @param tag
Description
This function adds the permitted values and the default value to the
description of the @param tag. They are added as a definition list
(\describe{}).
Usage
get_param_tag(act_param, defaults)
Arguments
act_param |
The content of the argument description to format A list with three named elements is expected:
|
defaults |
A list of default values from the function call
|
Value
The formatted @param tag
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.