ffrprep.datasets.download_example_data

ffrprep.datasets.download_example_data(dataset_path=None, with_stimuli=False)[source]

Download example EEG data (1 subject) for testing and tutorials.

Parameters:

  • 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 example data without specifying a path.

>>> download_example_data()

Download example data, specifying a path.

>>> download_example_data(dataset_path='/home/user/Desktop')