mne_bids.make_report

mne_bids.make_report(root, session=None, verbose=True)[source]

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
rootstr | pathlib.Path

The path of the root of the BIDS compatible folder.

sessionstr | None

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

verbosebool | None

Set verbose output to true or false.

Returns
paragraphstr

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

mne_bids.make_dataset_description mne_bids.write_anat