netneurotools.datasets.fetch_connectome
- netneurotools.datasets.fetch_connectome(dataset, data_dir=None, url=None, resume=True, verbose=1)[source]
Download files from multi-species connectomes.
- Parameters:
dataset (str) – Specifies which dataset to download; must be one of the datasets listed in
netneurotools.datasets.available_connectomes().data_dir (str, optional) – Path to use as data directory. If not specified, will check for environmental variable ‘NNT_DATA’; if that is not set, will use ~/nnt-data instead. Default: None
url (str, optional) – URL from which to download data. Default: None
resume (bool, optional) – Whether to attempt to resume partial download, if possible. Default: True
verbose (int, optional) – Modifies verbosity of download, where higher numbers mean more updates. Default: 1
- Returns:
data – Dictionary-like object with, at a minimum, keys [‘conn’, ‘labels’, ‘ref’] providing connectivity / correlation matrix, region labels, and relevant reference. Other possible keys include ‘dist’ (an array of Euclidean distances between regions of ‘conn’), ‘coords’ (an array of xyz coordinates for regions of ‘conn’), ‘acronyms’ (an array of acronyms for regions of ‘conn’), and ‘networks’ (an array of network affiliations for regions of ‘conn’)
- Return type:
References
See ref key of returned dictionary object for relevant dataset reference