api.rst

API Reference

.. currentmodule:: foehnix-python

Here all foehnix classes and functions will be listed.

Main classes and functions

.. autosummary::
    :toctree: generated/
    :nosignatures:

    foehnix.Foehnix
    foehnix.Family
    foehnix.GaussianFamily
    foehnix.LogisticFamily
    foehnix.foehnix.Control
    foehnix.Foehnix.no_concomitant_fit
    foehnix.Foehnix.unreg_fit
    foehnix.Foehnix.predict

Filter

.. autosummary::
    :toctree: generated/
    :nosignatures:

    foehnix.foehnix_filter

Support functions

.. autosummary::
    :toctree: generated/
    :nosignatures:

    foehnix.Foehnix.summary
    foehnix.Foehnix.plot
    foehnix.iwls_logit
    foehnix.iwls_logit.iwls_summary
    foehnix.get_demodata

Plotting

.. autosummary::
    :toctree: generated/
    :nosignatures:

    foehnix.model_plots.loglik
    foehnix.model_plots.loglikcontribution
    foehnix.model_plots.coef
    foehnix.model_plots.hist
    foehnix.analysis_plots.TSControl
    foehnix.analysis_plots.tsplot
    foehnix.analysis_plots.image