getParameterCaption {rpact} | R Documentation |
Get Parameter Caption
Description
Returns the parameter caption for a given object and parameter name.
Usage
getParameterCaption(obj, var)
Arguments
obj |
The rpact result object. |
var |
The variable/parameter name. |
Details
This function identifies and returns the caption that will be used in print outputs of an rpact result object.
Value
Returns a character
of specifying the corresponding caption of a given parameter name.
Returns NULL
if the specified parameterName
does not exist.
See Also
getParameterName()
for getting the parameter name for a given caption.
Examples
## Not run:
getParameterCaption(getDesignInverseNormal(), "kMax")
## End(Not run)
[Package rpact version 4.2.0 Index]