getParameterCaption: Get Parameter Caption
In rpact: Confirmatory Adaptive Clinical Trial Design and Analysis
View source: R/f_core_utilities.R
getParameterCaption R Documentation
Get Parameter Caption
Description
Returns the parameter caption for a given object and parameter name.
Usage
getParameterCaption(obj, parameterName)
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
getParameterCaption(getDesignInverseNormal(), "kMax")
rpact documentation built on July 9, 2023, 6:30 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.
View source: R/f_core_utilities.R
| getParameterCaption | R Documentation |
Get Parameter Caption
Description
Returns the parameter caption for a given object and parameter name.
Usage
getParameterCaption(obj, parameterName)
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
getParameterCaption(getDesignInverseNormal(), "kMax")
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.