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.

8.2.5.4. nilearn.datasets.get_data_dirs

nilearn.datasets.get_data_dirs(data_dir=None)[source]

Returns the directories in which nilearn looks for data.

This is typically useful for the end-user to check where the data is downloaded and stored.

Parameters
data_dirpathlib.Path or str, optional

Path where data should be downloaded. By default, files are downloaded in home directory.

Returns
pathslist of strings

Paths of the dataset directories.

Notes

This function retrieves the datasets directories using the following priority :

  1. defaults system paths

  2. the keyword argument data_dir

  3. the global environment variable NILEARN_SHARED_DATA

  4. the user environment variable NILEARN_DATA

  5. nilearn_data in the user home folder