mne.open_report

mne.open_report(fname, **params)[source]

Read a saved report or, if it doesn’t exist yet, create a new one.

The returned report can be used as a context manager, in which case any changes to the report are saved when exiting the context block.

Parameters
fnamestr

The file containing the report, stored in the HDF5 format. If the file does not exist yet, a new report is created that will be saved to the specified file.

**paramskwargs

When creating a new report, any named parameters other than fname are passed to the __init__ function of the Report object. When reading an existing report, the parameters are checked with the loaded report and an exception is raised when they don’t match.

Returns
reportinstance of Report

The report.