distr6 (version 1.3.7)

getParameterValue: Parameter Value Accessor

Description

Returns the value of the given parameter.

Usage

getParameterValue(object, id, error = "warn")

Arguments

object

Distribution or ParameterSet.

id

character, id of the parameter to return.

error

character, value to pass to stopwarn.

Value

The current value of a given parameter as a numeric.

R6 Usage

$getParameterValue(id, error = "warn")

Details

Returns NULL and warning if the given parameter is not in the Distribution, otherwise returns the value of the given parameter.

stopwarn either breaks the code with an error if "error" is given or returns NULL with warning otherwise.

See Also

parameters and setParameterValue