PIParameters

A parameter to be optimized in a parameter identification routine

Active bindings

parameters

A list of parameter objects. Adding or removing parameters is not supported.

currValue

The current parameter values for simulations, in units specified by $unit.

startValue

Initial value used for optimization.

minValue

Lowest permissible parameter value.

maxValue

Highest permissible parameter value.

unit

Parameter value units. Changing the unit does NOT automatically adjust min/max/start values. Values are converted from this unit to the parameter's base unit before they are applied to the model. With the HJKB algorithm, the declared unit also affects the search resolution because HJKB probes with absolute step sizes.

Methods

Public methods

• PIParameters$new()

• PIParameters$setValue()

• PIParameters$toDataFrame()

• PIParameters$print()

• PIParameters$clone()

---

PIParameters$new()

Initialize a new instance of the class. The initial start value is derived from the first parameter upon creation, modifiable via PIParameters$startValue. All parameters are optimized using this unified value.

Usage

PIParameters$new(parameters, minValue = NULL, maxValue = NULL)

Arguments

parameters

List of Parameter class objects to be optimized.

minValue

Optional lower bound. Defaults to NULL, in which case it is derived from the start value as start * 0.1 (or start * 10 when the start value is negative, so the bound stays below the start value). Required when the start value is zero.

maxValue

Optional upper bound. Defaults to NULL, in which case it is derived from the start value as start * 10 (or start * 0.1 when the start value is negative, so the bound stays above the start value). Required when the start value is zero.

Returns

A new PIParameters object.

---

PIParameters$setValue()

Updates parameter(s) value. Value is specified in units of $unit.

Usage

PIParameters$setValue(value)

Arguments

value

Numeric value to set.

---

PIParameters$toDataFrame()

Export parameter metadata and configuration to a data frame. Returns one row per internal model parameter wrapped by the PIParameters object.

Usage

PIParameters$toDataFrame(group = NULL)

Arguments

group

Optional character label identifying the optimization group.

Returns

A data.frame with one row per internal parameter.

---

PIParameters$print()

Prints a summary of the PIParameters.

Usage

PIParameters$print()

---

PIParameters$clone()

The objects of this class are cloneable with this method.

Usage

PIParameters$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.