ffrprep.datasets.download_raw_data

ffrprep.datasets.download_raw_data(subjects=1, dataset_path=None, with_stimuli=False)[source]

Download raw EEG data for specified subjects from OSF.

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.

  • with_stimuli (bool) – When True, additionally download the BIDS /stimuli/ directory used by stimulus-aware analyses (e.g. corr_stim_to_resp). When False (default), only the EEG data is fetched.

Returns:

dataset_path – Path to the directory containing the downloaded data.

Return type:

Path

Examples

Download data for 3 subjects without specifying a path.

>>> download_raw_data(subjects=3)

Download data for 5 subjects, specifying a path.

>>> download_raw_data(subjects=5, dataset_path='/home/user/Desktop')

Download specific subjects by ID.

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