getParameterName: Get Parameter Name

View source: R/f_core_utilities.R

getParameterNameR Documentation

Get Parameter Name

Description

Returns the parameter name for a given object and parameter caption.

Usage

getParameterName(obj, parameterCaption)

Arguments

obj

The rpact result object.

parameterCaption

The parameter caption.

Details

This function identifies and returns the parameter name for a given caption that will be used in print outputs of an rpact result object.

Value

Returns a character of specifying the corresponding name of a given parameter caption. Returns NULL if the specified parameterCaption does not exist.

See Also

getParameterCaption() for getting the parameter caption for a given name.

Examples

## Not run: 
getParameterName(getDesignInverseNormal(), "Maximum number of stages")

## End(Not run)


rpact documentation built on Sept. 27, 2024, 5:08 p.m.