msqms.io.bids_dataset module

msqms.io.bids_dataset module#

Read BIDS datasets

Summary#

Functions:#

`get_info_from_bids`
`get_subjects_from_bids`
`read_raw_bids_dataset`	Read and load MEG data from a BIDS dataset.

Reference#

msqms.io.bids_dataset.read_raw_bids_dataset(bids_root, datatype='meg', subjects=None, sessions=None, tasks=None, runs=None, print_dir=False, bids_report=False)[source]#

Read and load MEG data from a BIDS dataset.

Return type:

List

Parameters:

bids_root (str) – The root path of the BIDS dataset.
datatype ({'meg'}) – The type of data to read, currently only ‘meg’ is supported.(‘eeg’)
subjects (str, optional) – The specific subjects to load. Default is None, which loads all subjects.
sessions (str, optional) – The specific sessions to load. Default is None, which loads all sessions.
tasks (str, optional) – The specific tasks to load. Default is None, which loads all tasks.
runs (str, optional) – The specific runs to load. Default is None, which loads all runs.
print_dir (bool, optional) – If True, print the directory tree structure. Default is False.
bids_report (bool, optional) – If True, generate a BIDS report. Default is False.

Returns:

A list of MEG file paths.