mne_bids.make_report

mne_bids.make_report(root, session=None, verbose=None)

Create a methods paragraph string from BIDS dataset.

Summarizes the REQUIRED components in the BIDS specification and also some RECOMMENDED components. Currently, the methods paragraph summarize the:

• dataset_description.json file

• (optional) participants.tsv file

• (optional) datatype-agnostic files for (M/I)EEG data, which reads files from the *_scans.tsv file.

Parameters:

rootpath-like

The path of the root of the BIDS compatible folder.

sessionstr | None

The (optional) session for a item. Corresponds to “ses”.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:

paragraphstr

The paragraph wrapped with 80 characters per line describing the summary of the subjects.

Examples using mne_bids.make_report

01. Read BIDS datasets

01. Read BIDS datasets

05. BIDS conversion for group studies

05. BIDS conversion for group studies

12. Updating BIDS datasets

12. Updating BIDS datasets