neuralfetch.utils.runner.download_study¶

neuralfetch.utils.runner.download_study(name: str, path: str | Path | None = None, overwrite: bool = False, clean: bool = False, assume_yes: bool = False) → None[source][source]¶

Download a study’s raw dataset into path/<StudyName>/.

Parameters:

name (str) – Registered study class name (e.g. "Grootswagers2022Human").
path (str | Path | None) – Root folder for study data. Defaults to root_study_folder() (i.e. the NEURALSET_STUDY_FOLDER environment variable).
overwrite (bool) – If True, force re-download even when a success-file exists (files already on disk are re-fetched/verified rather than trusted).
clean (bool) – If True, delete the study’s download/ and prepare/ folders first, then re-download from scratch (implies overwrite=True). This is destructive; the caller is prompted for confirmation unless assume_yes is set.
assume_yes (bool) – Skip the interactive confirmation for clean (for non-interactive use). Ignored when clean is False.