sensitivity.classification¶

Classification of sensitivities and uncertainties.

The classes are the ones of the IPCS guidance for physiologically based pharmacokinetic models; an undefined value (NaN) has no class (None), so one undefined index does not stop the classification of the others.

SensitivityClassification ¶

Bases: StrEnum

Sensitivity classification.

UncertaintyClassification ¶

Bases: StrEnum

Uncertainty classification.

sensitivity_classification ¶

sensitivity_classification(s)

Classification of local sensitivity as per WHO IPCS guidance.

Classification based on absolute sensitivity:

High: |Si,j| >= 0.5
Medium: 0.2 <= |Si,j| < 0.5
Low: 0.1 <= |Si,j| < 0.2
Negligible: |Si,j| < 0.1

Parameters:

Name	Type	Description	Default
`s`	`float`	the normalized sensitivity.	required

Returns:

Type	Description
`SensitivityClassification \| None`	The class, `None` for an undefined value (`NaN`).

References

International Programme on Chemical Safety (IPCS). Characterization and application of physiologically based pharmacokinetic models in risk assessment. World Health Organization; 2010. Contract No.: 9.

sensitivity_classification_symbol ¶

sensitivity_classification_symbol(s)

Get the symbol of the class of a sensitivity.

Parameters:

Name	Type	Description	Default
`s`	`float`	the normalized sensitivity.	required

Returns:

Type	Description
`str`	The sign of the sensitivity once per class above negligible, `+++`
`str`	for a high positive and `-` for a low negative sensitivity, empty for
`str`	a negligible or an undefined one.

uncertainty_classification ¶

uncertainty_classification(u)

Classification of uncertainty as per WHO IPCS guidance.

Classification based on the absolute uncertainty, U = (P97.5 - P2.5) / P50 is negative for an output with a negative median, e.g. a change of the body weight (#311):

High: |Ui,j| >= 2
Medium: 0.3 <= |Ui,j| < 2
Low: 0 <= |Ui,j| < 0.3

Parameters:

Name	Type	Description	Default
`u`	`float`	the uncertainty.	required

Returns:

Type	Description
`UncertaintyClassification \| None`	The class, `None` for an undefined value (`NaN`); an infinite value,
`UncertaintyClassification \| None`	e.g. of an output whose median is 0, is `HIGH`.

References

International Programme on Chemical Safety (IPCS). Characterization and application of physiologically based pharmacokinetic models in risk assessment. World Health Organization; 2010. Contract No.: 9.

uncertainty_classification_symbol ¶

uncertainty_classification_symbol(u)

Get the symbol of the class of an uncertainty.

Parameters:

Name	Type	Description	Default
`u`	`float`	the uncertainty.	required

Returns:

Type	Description
`str`	A star per class in angle brackets, `<**>` for a high and `<>` for
`str`	a low uncertainty, empty for an undefined one.