nimare.io.convert_dataset_to_nimads_dict

convert_dataset_to_nimads_dict(dataset: Dataset, *, studyset_id: str = 'nimads_from_dataset', studyset_name: str = '', out_file: str | Path | None = None) → Dict[str, Any][source]

Convert a NiMARE Dataset to a NIMADS Studyset dictionary.

Warning

Dataset input is deprecated and will be removed in a future release. Prefer operating on Studyset directly, or convert once with convert_dataset_to_studyset().

Parameters:

  • dataset (Dataset) – Dataset instance derived from Sleuth or other sources.

  • studyset_id (str, optional) – Identifier for the resulting Studyset. Default is ‘nimads_from_dataset’.

  • studyset_name (str, optional) – Human-readable name for the Studyset. Default is ‘’.

  • out_file (str or pathlib.Path, optional) – Optional path to write the Studyset JSON. Default is None.

Returns:

NIMADS Studyset dictionary.

Return type:

dict