meeg_utils.report.from_derivative#

meeg_utils.report.from_derivative(fname, *, title=None)[source]#

Build a report of a derivative saved by meeg_utils.io.save_derivative().

The fitted pipeline is not saved, so its figures cannot be redrawn; the report shows what was saved: the pipeline’s steps and parameters, each step’s QC metrics, warnings, the provenance, and the data themselves (MNE’s views of Raw, Epochs or Evoked data, with spectra).

Parameters:

  • fname (str | Path) – The derivative .fif file (its JSON sidecar is read alongside).

  • title (str | None) – Report title (default: the file name).

Returns:

The report.

Return type:

mne.Report