.. _api:

fed3bandit API
==========================


Summary of functions
---------------------

.. automodule:: fed3bandit.fed3bandit
   
   .. rubric:: Functions

   .. autosummary::
   
      load_sampledata
      filter_data
      binned_paction
      count_pellets
      count_pokes
      pokes_per_pellet
      poke_accuracy
      reversal_peh
      win_stay
      lose_shift
      side_prewards
      side_nrewards
      create_X
      logit_regr
   

API Reference
--------------

.. automodule:: fed3bandit.fed3bandit
   :members:
   :show-inheritance:
   :member-order: bysource

Extending fed3bandit
---------------------

FED3Bandit is a actively being developed. We will keep adding more analysis features.
If you have any request, please open an issue on GitHub and we will try to implement it 
in a future release.