Skip to content

Latest commit

 

History

History
334 lines (229 loc) · 6.39 KB

api.rst

File metadata and controls

334 lines (229 loc) · 6.39 KB

API

.. automodule:: nimare.dataset
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: class.rst

   dataset.Dataset


:mod:`nimare.meta`: Meta-analytic algorithms

For more information about the components of coordinate-based meta-analysis in NiMARE, see :doc:`cbma`.

.. automodule:: nimare.meta
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: module.rst

   meta.ibma
   meta.cbma.ale
   meta.cbma.mkda
   meta.cbma.base
   meta.kernel

:mod:`nimare.results`: Meta-analytic results

.. automodule:: nimare.results
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: class.rst

   results.MetaResult


:mod:`nimare.correct`: Multiple comparisons correction

.. automodule:: nimare.correct
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: class.rst

   correct.FWECorrector
   correct.FDRCorrector


.. automodule:: nimare.diagnostics
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: class.rst

   diagnostics.Jackknife
   diagnostics.FocusCounter


:mod:`nimare.annotate`: Automated annotation

.. automodule:: nimare.annotate
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: module.rst

   annotate.cogat
   annotate.gclda
   annotate.lda
   annotate.text
   annotate.utils


:mod:`nimare.decode`: Functional characterization analysis

For more information about functional characterization analysis, see :doc:`decoding`.

.. automodule:: nimare.decode
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: module.rst

   decode.discrete
   decode.continuous
   decode.encode


:mod:`nimare.io`: Tools for ingesting data in other formats

.. automodule:: nimare.io
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: function.rst

   io.convert_neurosynth_to_dict
   io.convert_neurosynth_to_json
   io.convert_neurosynth_to_dataset
   io.convert_sleuth_to_dict
   io.convert_sleuth_to_json
   io.convert_sleuth_to_dataset
   io.convert_neurovault_to_dataset


:mod:`nimare.transforms`: Data transforms

.. automodule:: nimare.transforms
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: class.rst

   transforms.ImageTransformer
   transforms.ImagesToCoordinates

   :template: function.rst

   transforms.transform_images
   transforms.resolve_transforms
   transforms.sample_sizes_to_dof
   transforms.sample_sizes_to_sample_size
   transforms.sd_to_varcope
   transforms.se_to_varcope
   transforms.samplevar_dataset_to_varcope
   transforms.t_and_varcope_to_beta
   transforms.t_and_beta_to_varcope
   transforms.p_to_z
   transforms.t_to_z
   transforms.z_to_t
   transforms.z_to_p


:mod:`nimare.extract`: Dataset and model fetching

For more information about fetching data from the internet, see :ref:`fetching tools`.

.. automodule:: nimare.extract
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: function.rst

   extract.fetch_neuroquery
   extract.fetch_neurosynth
   extract.download_nidm_pain
   extract.download_cognitive_atlas
   extract.download_abstracts
   extract.download_peaks2maps_model

   extract.utils.get_data_dirs


:mod:`nimare.stats`: Statistical functions

.. automodule:: nimare.stats
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: function.rst

   stats.one_way
   stats.two_way
   stats.pearson
   stats.null_to_p
   stats.nullhist_to_p
   stats.fdr


:mod:`nimare.generate`: Data generation functions

.. automodule:: nimare.generate
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: function.rst

   generate.create_coordinate_dataset
   generate.create_neurovault_dataset


:mod:`nimare.utils`: Utility functions and submodules

.. automodule:: nimare.utils
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: function.rst

   utils.get_template
   utils.get_masker
   utils.get_resource_path
   utils.vox2mm
   utils.mm2vox
   utils.tal2mni
   utils.mni2tal

:mod:`nimare.workflows`: Common workflows

.. automodule:: nimare.workflows
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: function.rst

   workflows.ale_sleuth_workflow
   workflows.conperm_workflow
   workflows.macm_workflow
   workflows.peaks2maps_workflow
   workflows.scale_workflow


:mod:`nimare.base`: Base classes

.. automodule:: nimare.base
   :no-members:
   :no-inherited-members:

.. currentmodule:: nimare

.. autosummary::
   :toctree: generated/
   :template: class.rst

   base.NiMAREBase
   base.Estimator
   base.MetaEstimator
   base.Transformer
   base.Decoder