Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.
nilearn.datasets.fetch_openneuro_dataset#
- nilearn.datasets.fetch_openneuro_dataset(urls=None, data_dir=None, dataset_version='ds000030_R1.0.4', verbose=1)[source]#
Download OpenNeuro BIDS dataset.
This function specifically downloads files from a series of URLs. Unless you use
fetch_ds000030_urls
or the default parameters, it is up to the user to ensure that the URLs are correct, and that they are associated with an OpenNeuro dataset.- Parameters
- urlslist of string, optional
List of URLs to dataset files to download. If not specified, all files from the default dataset (
ds000030_R1.0.4
) will be downloaded.- data_dir
pathlib.Path
orstr
, optional Path where data should be downloaded. By default, files are downloaded in home directory.
- dataset_versionstring, optional
Dataset version name. Assumes it is of the form [name]_[version]. Default is
ds000030_R1.0.4
.- verbose
int
, optional Verbosity level (0 means no message). Default=1.
- Returns
- data_dirstring
Path to downloaded dataset.
- downloaded_fileslist of string
Absolute paths of downloaded files on disk.
Notes
The default dataset downloaded by this function is the “UCLA Consortium for Neuropsychiatric Phenomics LA5c” dataset 1.
This copy includes filenames that are not compliant with the current version of BIDS, so this function also calls
patch_openneuro_dataset
to generate BIDS-compliant symlinks.References
- 1
R.A. Poldrack, E. Congdon, W. Triplett, K.J. Gorgolewski, K.H. Karlsgodt, J.A. Mumford, F.W. Sabb, N.B. Freimer, E.D. London, T.D. Cannon, and R.M. Bilder. A phenome-wide examination of neural and cognitive function. Scientific Data, 3(1):160110, December 2016. URL: https://doi.org/10.1038/sdata.2016.110, doi:10.1038/sdata.2016.110.
Examples using nilearn.datasets.fetch_openneuro_dataset
#
First level analysis of a complete BIDS dataset from openneuro