nimare.io.convert_neurovault_to_dataset
- convert_neurovault_to_dataset(collection_ids, contrasts, img_dir=None, map_type_conversion=None, **dset_kwargs)[source]
Convert a group of NeuroVault collections into a NiMARE Dataset.
Added in version 0.0.8.
- Parameters:
collection_ids (
listofintordict) – A list of collections on neurovault specified by their id. The collection ids can accessed through the neurovault API (i.e., https://neurovault.org/api/collections) or their main website (i.e., https://neurovault.org/collections). For example, in this URL https://neurovault.org/collections/8836/, 8836 is the collection id. collection_ids can also be a dictionary whose keys are the informative study name and the values are collection ids to give the collections more informative names in the dataset.contrasts (
dict) – Dictionary whose keys represent the name of the contrast in the dataset and whose values represent a regular expression that would match the names represented in NeuroVault. For example, under theNamecolumn in this URL https://neurovault.org/collections/8836/, a valid contrast could be “as-Animal”, which will be called “animal” in the created dataset if the contrasts argument is{'animal': "as-Animal"}.img_dir (
stror None, optional) – Base path to save all the downloaded images, by default the images will be saved to a temporary directory with the prefix “neurovault”.map_type_conversion (
dictor None, optional) – Dictionary whose keys are what you expect the map_type name to be in neurovault and the values are the name of the respective statistic map in a nimare dataset. Default = None.**dset_kwargs (keyword arguments passed to Dataset) – Keyword arguments to pass in when creating the Dataset object. see
Datasetfor details.
- Returns:
Dataset object containing experiment information from neurovault.
- Return type:
