nimare.nimads.Study

class Study(source)[source]

Bases: object

A collection of Analyses from the same paper.

Added in version 0.0.14.

Variables:

  • id (str) – A unique identifier for the Study.

  • name (str) – A human readable name of the Study, typically the title of the paper.

  • authors (str) – A string of the authors of the paper.

  • publication (str) – A string of the publication information for the paper, typically a journal name.

  • metadata (dict) – A dictionary of metadata associated with the Study.

  • analyses (list of nimare.nimads.Analysis objects) – The Analysis objects comprising the Study. An analysis represents a contrast with statistical results.

Methods

get_analyses()

Collect Analyses from the Study.

to_dict()

Return a dictionary representation of the Study.
get_analyses()[source]

Collect Analyses from the Study.

Notes

What filters, if any, should we support in this method?

to_dict()[source]

Return a dictionary representation of the Study.