.. currentmodule:: psychopy_ext

.. _api:

Cheat Sheet
===========

----------
Experiment
----------

PATHS...
self.computer.valid_responses = {'space': 1}

Experiment
~~~~~~~~~~
.. autosummary::
   :toctree: generated/

   Experiment.__init__
   Experiment.create_win
   Experiment.before_exp
   Experiment.run
   Experiment.after_exp

Task
~~~~
.. autosummary::
   :toctree: generated/

Setup
"""""
   Task.__init__
   Task.create_fixation
   Task.create_stimuli
   Task.create_trial
   Task.create_exp_plan

Control
"""""""
   Task.before_task
   Task.run_task
   Task.after_task
   Task.before_block
   Task.run_block
   Task.after_block
   Task.run_trial
   Task.run_event
   Task.post_trial


After trial
"""""""""""
   Task.feedback

   Task.show_text
   Task.get_blocks


   Task.get_behav_df

During event
""""""""""""""""""""""
   Task.wait
   Task.check_continue
   Task.wait_until_response
   Task.idle_event
   Task.last_keypress


Helper classes
~~~~~~~~~~~~~~
.. autosummary::
   :toctree: generated/

   Event

Helper functions
~~~~~~~~~~~~~~~~
.. autosummary::
   :toctree: generated/

   set_paths
   get_behav_df
   try_makedirs
   signal_det
   invert_dict
   latin_square


--------------------
fMRI analyses (beta)
--------------------

Preproc
~~~~~~~
.. autosummary::
   :toctree: generated/

   Preproc.__init__
   Preproc.split_rp
   Preproc.gen_stats_batch

Analysis
~~~~~~~~
.. Analysis.plot_chunks
.. Analysis.genFakeData

.. autosummary::
   :toctree: generated/

   Analysis.__init__
   Analysis.run
   Analysis.get_fmri_df
   Analysis.get_behav_df
   Analysis.plot
   Analysis.run_method
   Analysis.get_mri_data
   Analysis.extract_samples
   Analysis.extract_labels
   Analysis.fmri_dataset
   Analysis.detrend
   Analysis.ds2evds
   Analysis.timecourse
   Analysis.signal
   Analysis.univariate
   Analysis.correlation
   Analysis.svm
   Analysis.plot_roi
   Analysis.read_csvs

Helper functions
~~~~~~~~~~~~~~~~
.. autosummary::
   :toctree: generated/

   plot_timecourse
   make_roi_pattern


------
Models
------
.. autosummary::
   :toctree: generated/

   Pixelwise
   GaborJet
   HMAX


--------------------
Statistical analyses
--------------------
.. autosummary::
   :toctree: generated/

   aggregate
   accuracy
   confidence
   get_star
   reorder
   df_fromdict
   nan_outliers
   oneway_anova
   p_corr
   reliability
   mds
   classical_mds


---------------
Pretty plotting
---------------
.. autosummary::
   :toctree: generated/

   Plot.__init__
   Plot.plot
   Plot.show
