eegprep.bids_list_eeg_files

eegprep.bids_list_eeg_files(root, subjects=(), sessions=(), runs=(), tasks=())

Return a list of all EEG raw-data files in a BIDS dataset.

Return type:

List[str]

Parameters:

• root (str)

• subjects (Sequence[str | int] | str | int)

• sessions (Sequence[str | int] | str | int)

• runs (Sequence[str | int] | str | int)

• tasks (Sequence[str | int] | str | int)

Parameters

rootstr

The root directory containing BIDS data.

subjectsSequence[str | int], optional

A sequence of subject identifiers or (zero-based) indices to filter the files by. If empty, all subjects are included.

sessionsSequence[str | int], optional

A sequence of session identifiers or (zero-based) indices to filter the files by. If empty, all sessions are included.

runsSequence[str | int], optional

A sequence of run numbers or identifiers to filter the files by. If empty, all runs are included. Note that zero-based indexing does not apply to runs, unlike subjects and sessions since runs are already integers.

tasksSequence[str] | str, optional

A sequence of task names or single task to filter the files by. If empty, all tasks are included (default is an empty sequence).

Returns

List[str]

A list of file paths to EEG files in the BIDS dataset.