meeg_utils.report.build

meeg_utils.report.build(pipeline=None, inst=None, qc=None, *, title='meeg-utils report')

Build an mne.Report with every metric and figure.

The report starts with the acquisition-quality checks (a table of all findings, then each check’s figures), followed by one section per pipeline step (its qc_ metrics and figures) and the provenance.

Parameters:

• pipeline (Pipeline | None) – A fitted pipeline.

• inst (Raw | None) – The pipeline’s input; with it, the figures that need data are drawn too (the pipeline is replayed, so each step plots its own input).

• qc (QCReport | None) – Results of meeg_utils.qc.inspect().

• title (str) – Report title.

Returns:

The report; save it with report.save("report.html").

Return type:

mne.Report