API Reference
=============

.. contents:: Subpackages
   :local:
   :depth: 1

stag.sync — Sensor synchronisation
------------------------------------

.. automodule:: stag.sync.data_sync
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.sync.utils
   :members:
   :undoc-members:
   :show-inheritance:

stag.database — Database models and ingestion
----------------------------------------------

.. automodule:: stag.database.deer_info
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.database.make_cluster_data
   :members:
   :undoc-members:
   :show-inheritance:

stag.gps — GPS trajectory analysis
------------------------------------

.. automodule:: stag.gps.analysis
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.gps.plotting
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.gps.tortuosity
   :members:
   :undoc-members:
   :show-inheritance:

stag.clustering — k-means clustering and evaluation
-----------------------------------------------------

.. automodule:: stag.clustering.kmeans
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.clustering.meta_analysis
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.clustering.plotting
   :members:
   :undoc-members:
   :show-inheritance:

stag.analysis — Behavioural sequence analysis
----------------------------------------------

.. automodule:: stag.analysis.label_analysis
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.analysis.preprocessing
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.analysis.nan_handler
   :members:
   :undoc-members:
   :show-inheritance:

stag.utils — Utility functions
-------------------------------

.. automodule:: stag.utils.csv_formatter
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: stag.utils.filename_generator
   :members:
   :undoc-members:
   :show-inheritance: