SensitivitySummary#

class causalpy.steps.sensitivity.SensitivitySummary[source]#

Aggregate result of all sensitivity checks.

results#

Individual check results.

Type:

list[CheckResult]

all_passed#

True if every check with a pass/fail criterion passed, False if any failed, or None if no check had a pass/fail criterion.

Type:

bool or None

text#

Combined prose summary.

Type:

str

Methods

SensitivitySummary.__init__([results, ...])

SensitivitySummary.from_results(results)

Build a summary from a list of check results.

Attributes

all_passed

text

results

__init__(results=<factory>, all_passed=None, text='')#
Parameters:
Return type:

None

classmethod __new__(*args, **kwargs)#