neuralfetch.download.Osf¶

class neuralfetch.download.Osf(*, study: str, dset_dir: str | Path, folder: str = 'download', storage_inds: list[int] = [0])[source][source]¶

Download datasets from OSF (osf.io).

Iterates over files in a project storage using osfclient and downloads them to dset_dir/download/. Already-downloaded files are skipped automatically.

Parameters:

study (str) – OSF project ID (5-character alphanumeric string, e.g. "abcde"). Found in the project URL: https://osf.io/<project_id>/.
storage_inds (list of int) – Indices of the project storages to download (default: [0]). Useful when a project exposes multiple named storages.