get_param_tag {admiraldev} | 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
[Package admiraldev version 1.3.1 Index]