pipeline.datasets.get_ucap#

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

Get sample data from the UCAP dataset.

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

Parameters

  • 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., ['05', '07']).

  • 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 (.vhdr)

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

  • 'besa_files' A list with the paths of the BESA calibration files (.matrix)

Return type

dict

See also

pipeline.datasets.get_erpcore

References

1

Frömer, R., Maier, M., & Abdel Rahman, R. (2018). Group-level EEG-processing pipeline for flexible single trial-based analyses including linear mixed models. Frontiers in Neuroscience, 12, 48. doi:10.3389/fnins.2018.00048