CheckResult

class causalpy.checks.base.CheckResult

Result of a single sensitivity / diagnostic check.

check_name

Human-readable name of the check.

Type:

str

passed

True if the check passed, False if it failed, or None if the check is purely informational (no pass/fail criterion).

Type:

bool or None

table

Optional diagnostic statistics table.

Type:

pd.DataFrame or None

text

Prose summary of the check result.

Type:

str

figures

Optional matplotlib figures produced by the check.

Type:

list

metadata

Arbitrary extra data that downstream steps (e.g. GenerateReport) can use.

Type:

dict

Methods

CheckResult.__init__(check_name[, passed, ...])

Attributes

passed
table
text
check_name
figures
metadata

__init__(check_name, passed=None, table=None, text='', figures=<factory>, metadata=<factory>)

Parameters:

• check_name (str)

• passed (bool | None)

• table (DataFrame | None)

• text (str)

• figures (list[Any])

• metadata (dict[str, Any])

Return type:

None

classmethod __new__(*args, **kwargs)