get_pk_parameters#

pharmpy.modeling.get_pk_parameters(model, kind='all')[source]#

Retrieves PK parameters in pharmpy.model.Model.

Parameters:
  • model (Model) – Pharmpy model to retrieve the PK parameters from

  • kind ({‘absorption’, ‘distribution’, ‘elimination’, ‘all’}) – The type of parameter to retrieve: ‘absorption’, ‘distribution’, ‘elimination’, or ‘all’ (default).

Returns:

list[str] – A list of the PK parameter names of the given model

Example

>>> from pharmpy.modeling import *
>>> model = load_example_model("pheno")
>>> get_pk_parameters(model)
['CL', 'VC']
>>> get_pk_parameters(model, 'absorption')
[]
>>> get_pk_parameters(model, 'distribution')
['VC']
>>> get_pk_parameters(model, 'elimination')
['CL']