pipeline.datasets.get_erpcore#

pipeline.datasets.get_erpcore(component, participants=40, path=None)[source]#

Get sample data from the ERP CORE dataset.

Data that are not yet available locally will be downloaded from the OSF. See 1 for details on the ERP CORE dataset.

Parameters

  • component (str) –

    Which ERP CORE experiment to download. Each experiment was designed to elicit one of seven common ERP components:

    • 'ERN' (flanker task)

    • 'LRP' (flanker task)

    • 'MMN' (passive auditory oddball task)

    • 'N170' (face perception task)

    • 'N2pc' (simple visual search task)

    • 'N400' (word pair judgment task)

    • 'P3' (active visual oddball task)

  • participants (int or list of str, optional) – Which participants to download. By default, downloads all 40 participants available in the dataset. If an integer, downloads that many participants starting from the first participant. If a list of strings, downloads the participants with the given IDs (e.g., ['sub-001', 'sub-002']).

  • path (str or Path, optional) – Local directory path to download the data to. By default, uses the user’s local cache directory. An alternative way to specify the download path is to set the environment variable PIPELINE_DATA_DIR.

Returns

A dictionary with the file paths of the downloaded data:

  • 'raw_files': A list with the paths of the raw EEG files (eeg.set)

  • 'log_files' A list with the paths of the log files (events.tsv)

Return type

dict

See also

pipeline.datasets.get_ucap

References

1

Kappenman, E. S., Farrens, J. L., Zhang, W., Stewart, A. X., & Luck, S. J. (2021). ERP CORE: An open resource for human event-related potential research. NeuroImage, 225, 117465. doi:10.1016/j.neuroimage.2020.117465