Add compartment to PKModelDesign
object
PKCompartmentObj
=
addCompartment(PKModelDesignObj
, CompObjName
)
PKCompartmentObj
=
addCompartment(PKModelDesignObj
, CompObjName
, Name
, Value
)
constructs
a PK compartment with the specified name and adds it to PKCompartmentObj
=
addCompartment(PKModelDesignObj
, CompObjName
)PKModelDesignObj
,
a PKModelDesign
object.
constructs
a PK compartment with the specified name, and with additional options
specified by one or more PKCompartmentObj
=
addCompartment(PKModelDesignObj
, CompObjName
, Name
, Value
)Name,Value
pair arguments.
PKModelDesignObj | PKModelDesign object to
which you want to add a compartment |
CompObjName | Name of the PKCompartment object that is constructed, specified as a
character vector or string. |
Optional comma-separated pairs of Name, Value
arguments,
where Name
is the argument name and Value
is
the corresponding value. Name
must appear
inside single quotes (''
). You can specify several
name-value pair arguments in any order as Name1,Value1,…,NameN,ValueN
.
DosingType | Character vector (or string) specifying the mechanism for drug absorption. Choices are:
For more information, see Dosing Types. |
EliminationType | Character vector (or string) specifying the mechanism for drug elimination. Choices are:
For more information, see Elimination Types. |
HasResponseVariable | Logical indicating if the drug concentration in this
compartment is reported. Multiple compartments in a model can have
this property set to Note If you perform a parameter fit on a model, at least one compartment
in the model must have a |
HasLag | Logical indicating if any dose targeting this compartment
have a lag associated with them. Default is |
These optional name-value pair arguments set the corresponding
property of the PKCompartment
object. You can also
set these properties after creating the PKCompartment
object
by using the following syntax:
PKCompartmentObj.PropertyName = Value
For example:
PKCompartmentObj.DosingType = 'Bolus'
PKCompartmentObj | PKCompartment
object |
delete | Delete SimBiology object |
display | Display summary of SimBiology object |
get | Get SimBiology object properties |
set | Set SimBiology object properties |
DosingType | Drug dosing type in compartment |
EliminationType | Drug elimination type from compartment |
HasLag | Lag associated with dose targeting compartment |
HasResponseVariable | Compartment drug concentration reported |
Name | Specify name of object |
Create a Pharmacokinetic Model Using the Command Line, HasLag
, HasResponseVariable
, PKCompartment object
, PKModelDesign object