ffrprep.datasets.download_epoch_data¶

ffrprep.datasets.download_epoch_data(subjects=1, dataset_path=None)[source]¶

Download epoched EEG data for specified subjects from OSF.

Data will be organized following BIDS derivatives structure within the raw dataset directory.

Parameters:

subjects (int or list) – Number of subjects to download (int) or specific subject IDs (list). If int, downloads the first N subjects. If list, downloads specific subjects by ID (e.g., [‘03’, ‘21’]). Default = 1.
dataset_path (string) – Path where the files will be saved. If None, the files will be saved in the current working directory. Default = None.

Returns:

dataset_path – Path to the directory containing the downloaded data.

Return type:

Path

Examples

Download epoched data for 2 subjects without specifying a path.

>>> download_epoch_data(subjects=2)

Download epoched data for 4 subjects, specifying a path.

>>> download_epoch_data(subjects=4, dataset_path='/home/user/Desktop')

Download specific subjects by ID.

>>> download_epoch_data(subjects=['03', '21'],
...                     dataset_path='/home/user/Desktop')