Documentation

addCompartment (PKModelDesign)

Add compartment to PKModelDesign object

Syntax

PKCompartmentObj = addCompartment(PKModelDesignObj, CompObjName)
PKCompartmentObj = addCompartment(PKModelDesignObj, CompObjName, Name, Value)

Description

PKCompartmentObj = addCompartment(PKModelDesignObj, CompObjName) constructs a PK compartment with the specified name and adds it to PKModelDesignObj, a PKModelDesign object.

PKCompartmentObj = addCompartment(PKModelDesignObj, CompObjName, Name, Value) constructs a PK compartment with the specified name, and with additional options specified by one or more Name,Value pair arguments.

Input Arguments

PKModelDesignObjPKModelDesign object to which you want to add a compartment
CompObjNameName of the PKCompartment object that is constructed

Name-Value Pair Arguments

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

String specifying the mechanism for drug absorption. Choices are:

  • 'Bolus'

  • 'Infusion'

  • 'ZeroOrder'

  • 'FirstOrder'

  • '' (default)

For more information, see Dosing Types.

EliminationType

String specifying the mechanism for drug elimination. Choices are:

  • 'Linear'

  • 'Linear-Clearance'

  • 'Enzymatic'

  • '' (default)

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 true. Default is false.

    Note:   If you perform a parameter fit on a model, at least one compartment in the model must have a HasResponseVariable property set to true.

HasLag

Logical indicating if any dose targeting this compartment have a lag associated with them. Default is false.

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'

Output Arguments

PKCompartmentObjPKCompartment object

Method Summary

get (any object)Get object properties
set (any object)Set object properties

Property Summary

DosingTypeDrug dosing type in compartment
EliminationTypeDrug elimination type from compartment
HasLagLag associated with dose targeting compartment
HasResponseVariableCompartment drug concentration reported
NameSpecify name of object
Was this topic helpful?