Python API
==========

Part of :doc:`index` — MORIE API reference.

Reference for every public ``morie.*`` module.
Signatures and docstrings come from ``sphinx.ext.autodoc``; see
:doc:`../methods/index` for the methodology behind each function.

Causal inference
----------------

.. automodule:: morie.causal
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.effects
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.matching
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.iv
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.rdd
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.did
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.sensitivity
   :members:
   :undoc-members:
   :show-inheritance:

Survey + descriptive statistics
-------------------------------

.. automodule:: morie.survey
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.sampling
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.survival
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.statistics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.bootstrap_methods
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.multiple_testing
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.effect_sizes
   :members:
   :undoc-members:
   :show-inheritance:

Datasets
--------

.. automodule:: morie.dataset
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.data
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.bq
   :members:
   :undoc-members:
   :show-inheritance:

OTIS — Ontario Tracking and Information System
----------------------------------------------

.. automodule:: morie.otis
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.otis_analyze
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.otis_all_analyze
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.otis_causal
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.otis_churn
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.otis_datasets
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.otis_tps_overlay
   :members:
   :undoc-members:
   :show-inheritance:

TPS — Toronto Police Service
----------------------------

.. automodule:: morie.tps_io
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_datasets
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_crime
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_csi
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_temporal
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_spatial
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_spatial_advanced
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_stochastic
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_hawkes_advanced
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_statphysics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_render
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.tps_all_analyze
   :members:
   :undoc-members:
   :show-inheritance:

Federal SIU — Sprott / Doob / Iftene replication
------------------------------------------------

.. automodule:: morie.sprott_doob
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.siuiap
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: morie.doob_trends
   :members:
   :undoc-members:
   :show-inheritance:

Psychometrics
-------------

.. automodule:: morie.psymet
   :members:
   :undoc-members:
   :show-inheritance:

Function namespace ``morie.fn``
---------------------------------

The ``morie.fn`` namespace exposes 36,000+ individual function
files, indexed by a registry. The full registry is the canonical
catalogue:

.. automodule:: morie.fn._registry
   :members:
   :undoc-members:

Result containers shared across the package:

.. automodule:: morie.fn._containers
   :members:
   :undoc-members:

.. automodule:: morie.fn._richresult
   :members:
   :undoc-members: