Rate

Rate of dose

The Rate property of a ScheduleDose object is a column vector instead of a row vector. For details, see Compatibility Considerations.

Description

Rate is a property of a RepeatDose or ScheduleDose object.

This property defines how fast a dose is given. If the rate is set to 0 or an empty array [], then it is interpreted as a bolus (instantaneous) dose.

For RepeatDose objects, you can parameterize the property by setting it to the name of a model-scoped parameter that is not being modified by a repeated assignment rule, an algebraic rule, or a rate rule. However, the parameter can be modified by an event.

Note

If you set the Rate property of a dose, you must also specify the Amount property of the dose, and set the DurationParameterName property to ''. This is because the duration is calculated from the amount and rate.

Tip

You can create a combination of bolus and infusion doses by setting the rate property of a ScheduleDose object to a vector containing zeros and non-zeros.

Characteristics

Applies to	Objects: RepeatDose, ScheduleDose.
Data type	double or character vector (RepeatDose) or double column (ScheduleDose).
Data values	Nonnegative real number or name of a model-scoped parameter object. The default value is 0 (RepeatDose) or 0x1 empty double column vector (ScheduleDose), that is, the dose is interpreted as a bolus (instantaneous) dose.
Access	Read/write.

Version History

R2019b: Rate property of ScheduleDose is a column vector

The Rate property of a ScheduleDose object is a column vector instead of a row vector. The default value is 0x1 empty double column vector, instead of [].