meeg_utils.qc.inspect_dataset#
- meeg_utils.qc.inspect_dataset(sources, checks=None, *, n_jobs=1, min_recordings=5)[source]#
Run the quality checks on every recording of a dataset.
- Parameters:
sources (sequence of str | Path | BIDSPath, or str | Path) – The recordings, or the root of a BIDS dataset (every MEG and EEG recording in it is checked; derivatives are ignored).
checks (sequence of Check | None) – Checks to run on each recording (cloned per recording);
Noneruns the default applicable checks, asinspect().n_jobs (int) – Recordings checked in parallel (joblib).
min_recordings (int) – Minimum number of recordings for outlier detection on a metric.
- Returns:
Per-recording reports, a metrics table and the outlying recordings. A recording whose checks raise is listed in
errors; the others are still checked.- Return type: