Learn more about SimBiology

sbiosetdosingprofile - Add objects to model for dosing

Syntax

modModelObj = sbiosetdosingprofile(modelObj, DoseVariable, DosingTable, DosingType)

Arguments

`modModelObj`	Modified model object containing dosing information, returned by `sbiosetdoingprofile`.
`modelObj`	SimBiology model object to which you want to add dosing information.
`DoseVariable`	Name of a species or parameter object in `modelObject`. `sbiosetdosingprofile` adds events that change the amount or value of the `DoseVariable` as defined by the `DosingTable` and `DosingType`.
`DosingTable`	An `nx2` matrix with the first column defining the time of the dose and the second column defining the dose amount. If `DosingType` is `'Infusion'`, then `DosingTable` must be `nx3` with a third column that defines the rate of infusion.
`DosingType`	Specifies the mechanism for drug dosing. Valid options are `'Bolus'`, `'Infusion'`, `'ZeroOrder'`, `'FirstOrder'` and `''`. For more information on `DosingType` see About Dosing Types in the SimBiology User's Guide.

Description

modModelObj = sbiosetdosingprofile(modelObj, DoseVariable, DosingTable, DosingType) adds SimBiology event and rule objects to the model object modelObj to perform the dosing as specified by DoseVariable, DosingTable, and DosingType and returns the modified model object, modModelObj.

While SimBiology performs dimensional checks and unit conversions for components in a model, it does not handle units for quantities in DosingTable. For more information about units in DosingTable, see Unit Conversion for Imported Data and the Model in the SimBiology User's Guide.

To facilitate the removal of the modified components from the model object, sbiosetdosingprofile adds the keyword 'DOSE_COMPONENT' to the Tag property for the events and the associated parameters added to the model object, modelObject.

To remove the modified components from the modified model object, modModelObject, use delete(sbioselect(modModelObject, 'Tag', 'DOSE_COMPONENT'));.

Model Components Added by sbiosetdosingprofile

sbiosetdosingprofile adds the following model components based on the dosing type you selected.

In the parameter names below, the suffix '_n' denotes a numeric suffix that gives each parameter a unique name. The first dosing parameter is named with the suffix '_1', the second with '_2', and so on.

For all dosing types sbiosetdosingprofile adds a parameter, DosingGroupID that causes dosing rules and events to be evaluated only when the parameter value is 1.

Bolus:

A parameter, BolusDoseAsAmount_n, that represents the time of the doses.
For a dose at time = 0
- An initial assignment rule that increases the initial drug concentration (by default = 0), by the sum of all doses occurring at time = 0, divided by the compartment volume.
For doses at time > 0
- A parameter for all doses occurring at time, BolusDoseTime_n, that represents the time of the doses.
- An event at BolusDoseTime_n that increases the drug concentration by the sum of all doses occurring at that dose time.

Infusion:

A parameter named InfusionRateChange_n with a value equal to the infusion rate.
A second parameter named InfusionRateChange_n with a value equal to the negative of the infusion rate; used to end the infusion dose.
For a dose at time = 0
- An initial assignment rule to increase the parameter representing the rate of infusion (kInf) by the sum of all doses occurring at time = 0.
For doses starting or ending at time > 0
- A parameter, InfusionChangeTime_n, that represents time of the dose changes occurring at the same time. The start of a dose is the time listed in DosingTable. The end of a dose is InfusionChangeTime_n + amount/rate of infusion. Amount and rate are values specified in the second and third columns respectively of DosingTable.
- An event at InfusionChangeTime_n that changes the value of kInf by the sum of all dose changes occurring at this time.

Zero-order:

Note For custom models, include a parameter named Tk0, representing the duration of drug absorption.

A parameter, ZeroOrderDoseStart_n, with a value equal to the amount of the dose.
A second parameter, ZeroOrderDoseEnd_n with a value equal to the negative of the amount of the dose; used to end the dose.
If doses start at time = 0
- An initial assignment rule to increase the parameter representing the absorption rate constant (ka) by the sum of all doses occurring at time = 0, divided by Tk0.
If doses start at time > 0
- A parameter, ZeroOrderDoseStartTime_n, that represents the start of the dose. This value is defined in the first column of DosingTable.
- An event at ZeroOrderDoseStartTime_n that increases the parameter representing the absorption rate constant (ka) by the sum of all doses starting at this time, divided by Tk0.
For the end of all doses, which occurs at time > 0
- A parameter ZeroOrderDoseEndTime_n that is used to end the dose and has a value equal to the dose start time. (Because the numerical value depends on the parameter Tk0, it cannot be set explicitly to the actual end time.)
- An event occurring at time ZeroOrderDoseEndTime_n + Tk0 that decreases the parameter representing the absorption rate constant (ka) by the sum of all doses ending at this time, divided by Tk0

First-order:

For each dose, a parameter, FirstOrderDoseAmount_n, that holds the dose amount for the current dose.
For a dose at time = 0
- An initial assignment rule that increases Dose by the sum of all doses occurring at time = 0.
For each dose at time > 0
- A parameter for all doses occurring at this time, FirstOrderDoseTime_n, that represents the time of the dose.
- A parameter, FirstOrderDoseAmount_n, that holds amount of the dose.
- An event at FirstOrderDoseTime_n that increases the value of Dose by the sum of all doses occurring at that dose time.

sbiosetdosingprofile - Add objects to model for dosing

Syntax

Arguments

Description

Model Components Added by sbiosetdosingprofile

See Also

Recommended Products