Skip to content

Commit

Permalink
Refactored modules related to input-output (#194)
Browse files Browse the repository at this point in the history
* added from_numpy() function to the load_poses module

* unit test new function

* use from_numpy() function in other loaders as well

* add Examples section to docstring and render in API index

* add Examples section to docstring and render in API index

* confidence array is optional

* None is the default for confidence

* rename private functions

* renamef from_dlc_df to from_dlc_style_df

* harmonise docstrings in load_poses

* harmonised function names and docstrings in save_poses

* harmonised docstrings in validators

* split Input/Output section of API index into modules

* renamed `_from_lp_or_dlc_file` to `_ds_from_lp_or_dlc_file`
  • Loading branch information
niksirbi authored Jun 3, 2024
1 parent 0f2cd88 commit 8e20498
Show file tree
Hide file tree
Showing 7 changed files with 276 additions and 159 deletions.
18 changes: 12 additions & 6 deletions docs/source/api_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,33 @@ API Reference
=============


Input/Output
------------
Load poses
----------
.. currentmodule:: movement.io.load_poses
.. autosummary::
:toctree: api

from_numpy
from_file
from_sleap_file
from_dlc_file
from_dlc_df
from_lp_file
from_dlc_style_df

Save poses
----------

.. currentmodule:: movement.io.save_poses
.. autosummary::
:toctree: api

to_dlc_file
to_dlc_df
to_sleap_analysis_file
to_lp_file
to_sleap_analysis_file
to_dlc_style_df

Validators
----------
.. currentmodule:: movement.io.validators
.. autosummary::
:toctree: api
Expand Down Expand Up @@ -58,7 +64,7 @@ Filtering


Analysis
-----------
--------
.. currentmodule:: movement.analysis.kinematics
.. autosummary::
:toctree: api
Expand Down
Loading

0 comments on commit 8e20498

Please sign in to comment.