nimare.io.convert_sleuth_to_dataset

convert_sleuth_to_dataset(text_file, target='ale_2mm')[source]

Convert Sleuth output text file into NiMARE Dataset.

Warning

Dataset output is deprecated and will be removed in a future release. Prefer convert_sleuth_to_studyset().

Parameters:
  • text_file (str or list of str) – Path to Sleuth-format text file. More than one text file may be provided.

  • target ({'ale_2mm', 'mni152_2mm'} or None, optional) – Target template space for coordinates. If None, coordinates remain in the reference space indicated by the Sleuth file’s //Reference= header and no template-based masker is created. If a template name is provided, coordinates are transformed into that space and a corresponding Dataset masker is created.

Returns:

Dataset object containing experiment information from text_file.

Return type:

Dataset