meeg_utils.qc.QCReport

class meeg_utils.qc.QCReport(checks, skipped, source=None)

The results of several checks on one recording.

Parameters:

• checks (dict) – Check name mapped to the computed Check.

• skipped (dict) – Check name mapped to why it did not run.

• source (str | None) – The recording.

__init__(checks, skipped, source=None)

Methods

__init__(checks, skipped[, source])
plot(*[, inst])	Draw the figures of every check.
to_dict()	Return a JSON-serializable summary (metrics, findings, skipped checks).
to_records()	Return one row per finding, e.g. for pandas.DataFrame(report.to_records()).

Attributes

findings	All findings of all checks.
flags	The findings that are "warn" or "fail", worst first.
level	The worst verdict over all checks.

property findings: list[Finding]

All findings of all checks.

property flags: list[Finding]

The findings that are "warn" or "fail", worst first.

property level: str

The worst verdict over all checks.

to_dict()

Return a JSON-serializable summary (metrics, findings, skipped checks).

to_records()

Return one row per finding, e.g. for pandas.DataFrame(report.to_records()).

plot(*, inst=None)

Draw the figures of every check.

Parameters:

inst (Raw | None) – Data for the figures that need it.

Returns:

Check name mapped to {kind: Figure}.

Return type:

dict