ffrprep.datasets.download_stimuli¶

ffrprep.datasets.download_stimuli(dataset_path=None)[source]¶

Download FFR stimulus files into a BIDS-compliant stimuli/ directory.

Stimulus files are referenced by the stim_file column of each BIDS events.tsv and consumed by stimulus-aware analyses (e.g. ffrprep.analysis.corr_stim_to_resp()). They are shared across subjects, so they land at <dataset>/ffrprep_raw_data/stimuli/ per the BIDS specification. After downloading, every sub-*/eeg/*_events.tsv is augmented with a stim_file column based on STIM_FILE_MAP so the downstream analysis has the linkage to operate on.

Parameters:: dataset_path (string, optional) – Path where the files will be saved. If None, the files will be saved in the current working directory.
Returns:: stim_dir – Path to the stimuli/ directory under the dataset root.
Return type:: Path