add_effect_compartment#

pharmpy.modeling.add_effect_compartment(model, expr)[source]#

Add an effect compartment.

Implemented PD models are:

• Linear:

  $$E=B\cdot (1+\text{slope}\cdot C)$$

• Emax:

  $$E=B\cdot (1+\frac{E_{max}\cdot C}{E{C}_{50}+C})$$

• Step effect:

  $$E=\{\genfrac{}{}{0ex}{}{B\text{if C}\le 0}{B\cdot (1+E_{max})\text{else}}$$

• Sigmoidal:

  $$E=\{\genfrac{}{}{0ex}{}{B\cdot (1+\frac{E_{max}\cdot C^n}{E{C}_{50}^n+C^n})\text{if C}>0}{B\text{else}}$$

• Log-linear:

  $$E=\text{slope}\cdot \text{log}(C+C_0)$$

$B$ is the baseline effect

Parameters:

• model (Model) – Pharmpy model

• expr ({‘linear’, ‘emax’, ‘sigmoid’, ‘step’, ‘loglin’}) – Name of the PD effect function.

Returns:

Model – Pharmpy model object

Examples

>>> from pharmpy.modeling import *
>>> model = load_example_model("pheno")
>>> model = add_effect_compartment(model, "linear")
>>> model.statements.ode_system.find_compartment("EFFECT")
Compartment(EFFECT, amount=A_EFFECT(t), input=KE0*A_CENTRAL(t)/VC)