nimare.io.convert_dataset_to_studyset

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

Convert a NiMARE Dataset into a nimads.Studyset object.

This is a convenience wrapper around convert_dataset_to_nimads_dict() that returns a fully-constructed nimare.nimads.Studyset instance instead of a plain dictionary. If out_file is provided, the underlying NIMADS dictionary will also be written to disk (same behavior as convert_dataset_to_nimads_dict()).

Warning

Dataset input is deprecated and will be removed in a future release. For new workflows, prefer starting from Studyset directly.

Parameters:

  • dataset – NiMARE Dataset to convert.

  • studyset_id – Identifier for the resulting Studyset.

  • studyset_name – Human-readable name for the Studyset.

  • out_file – Optional path to write the intermediate Studyset JSON.

Returns:

Constructed Studyset object.

Return type:

nimads.Studyset