mne_bids.make_report#
- mne_bids.make_report(root, session=None, verbose=None)[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:
- rootpath-like
The path of the root of the BIDS compatible folder.
- session
str
|None
The (optional) session for a item. Corresponds to “ses”.
- verbose
bool
|str
|int
|None
Control verbosity of the logging output. If
None
, use the default verbosity level. See the logging documentation andmne.verbose()
for details. Should only be passed as a keyword argument.
- Returns:
- paragraph
str
The paragraph wrapped with 80 characters per line describing the summary of the subjects.
- paragraph
Examples using mne_bids.make_report
#
05. BIDS conversion for group studies