`nimare.extract`.fetch_neuroquery

fetch_neuroquery(data_dir=None, version='1', overwrite=False, return_type='studyset', target='mni152_2mm', **kwargs)[source]

Download the latest data files from NeuroQuery.

Added in version 0.0.10.

Parameters:

data_dir (pathlib.Path or str, optional) – Path where data should be downloaded. By default, files are downloaded in home directory.
version (str or list, optional) – The version to fetch. The default is “7” (Neurosynth’s latest version).
url (None or str, optional) – Specific URL to download. If not None, overrides URL to current data. If you want to fetch Neurosynth’s data from before the 2021 reorganization, you will need to use this argument.
kwargs – Keyword arguments to select relevant feature files. Valid kwargs include: source, vocab, type. Each kwarg may be a string or a list of strings. If no kwargs are provided, all feature files for the specified database version will be downloaded.
return_type ({"studyset", "dataset", "files"}, optional) – Type of object to return after downloading. The default is "studyset". Use "dataset" for the legacy Dataset return type or "files" to return the downloaded file manifest without conversion.
target ({'mni152_2mm', 'ale_2mm'}, optional) – Target template space used when constructing Dataset or Studyset outputs. Ignored when return_type="files".

Returns:

outputs – List of downloaded databases, returned as Studysets, Datasets, or file-manifest dictionaries depending on return_type.

Return type:

list

Notes

This function was adapted from neurosynth.base.dataset.download().

Warning

return_type="dataset" is deprecated and will be removed in a future release. Prefer the default return_type="studyset".

Examples using `nimare.extract.fetch_neuroquery`