Update documentation

int-brain-lab · Feb 15, 2024 · 81f6705 · 81f6705
1 parent da6ccfa
commit 81f6705
Show file tree

Hide file tree

Showing 175 changed files with 6,136 additions and 1,740 deletions.
diff --git a/_autosummary/brainbox.behavior.dlc.html b/_autosummary/brainbox.behavior.dlc.html
@@ -145,7 +145,7 @@
 
   <section id="module-brainbox.behavior.dlc">
 <span id="brainbox-behavior-dlc"></span><h1>brainbox.behavior.dlc<a class="headerlink" href="#module-brainbox.behavior.dlc" title="Link to this heading"></a></h1>
-<p>Set of functions to deal with dlc data</p>
+<p>Set of functions to deal with dlc data.</p>
 <p class="rubric">Functions</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
@@ -173,12 +173,7 @@
 <td><p>Compute sniff times from the nose tip</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.dlc.get_speed" title="brainbox.behavior.dlc.get_speed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_speed</span></code></a></p></td>
-<td><p><dl class="field-list simple">
-<dt class="field-odd">param dlc<span class="colon">:</span></dt>
-<dd class="field-odd"><p>dlc pqt table</p>
-</dd>
-</dl>
-</p></td>
+<td><p>FIXME Document and add unit test!</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#brainbox.behavior.dlc.get_speed_for_features" title="brainbox.behavior.dlc.get_speed_for_features"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_speed_for_features</span></code></a></p></td>
 <td><p>Wrapper to compute speed for a number of dlc features and add them to dlc table</p></td>
@@ -187,7 +182,7 @@
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#brainbox.behavior.dlc.likelihood_threshold" title="brainbox.behavior.dlc.likelihood_threshold"><code class="xref py py-obj docutils literal notranslate"><span class="pre">likelihood_threshold</span></code></a></p></td>
-<td><p>Set dlc points with likelihood less than threshold to nan</p></td>
+<td><p>Set dlc points with likelihood less than threshold to nan.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.dlc.plot_lick_hist" title="brainbox.behavior.dlc.plot_lick_hist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_lick_hist</span></code></a></p></td>
 <td><p>Plots histogramm of lick events aligned to feedback time, separate for correct and incorrect trials</p></td>
@@ -228,7 +223,8 @@
 <dl class="py function">
 <dt class="sig sig-object py" id="brainbox.behavior.dlc.likelihood_threshold">
 <span class="sig-name descname"><span class="pre">likelihood_threshold</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dlc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.9</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/brainbox/behavior/dlc.html#likelihood_threshold"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brainbox.behavior.dlc.likelihood_threshold" title="Link to this definition"></a></dt>
-<dd><p>Set dlc points with likelihood less than threshold to nan</p>
+<dd><p>Set dlc points with likelihood less than threshold to nan.</p>
+<p>FIXME Add unit test.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
@@ -245,7 +241,8 @@
 <dl class="py function">
 <dt class="sig sig-object py" id="brainbox.behavior.dlc.get_speed">
 <span class="sig-name descname"><span class="pre">get_speed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dlc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dlc_t</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feature</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'paw_r'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/brainbox/behavior/dlc.html#get_speed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brainbox.behavior.dlc.get_speed" title="Link to this definition"></a></dt>
-<dd><dl class="field-list simple">
+<dd><p>FIXME Document and add unit test!</p>
+<dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>dlc</strong> – dlc pqt table</p></li>

diff --git a/_autosummary/brainbox.behavior.html b/_autosummary/brainbox.behavior.html
@@ -148,7 +148,7 @@
 <table class="autosummary longtable docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="brainbox.behavior.dlc.html#module-brainbox.behavior.dlc" title="brainbox.behavior.dlc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior.dlc</span></code></a></p></td>
-<td><p>Set of functions to deal with dlc data</p></td>
+<td><p>Set of functions to deal with dlc data.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="brainbox.behavior.training.html#module-brainbox.behavior.training" title="brainbox.behavior.training"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior.training</span></code></a></p></td>
 <td><p>Computing and testing IBL training status criteria.</p></td>

diff --git a/_autosummary/brainbox.behavior.training.html b/_autosummary/brainbox.behavior.training.html
@@ -280,7 +280,7 @@
 
 <dl class="py class">
 <dt class="sig sig-object py" id="brainbox.behavior.training.TrainingStatus">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TrainingStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/brainbox/behavior/training.html#TrainingStatus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brainbox.behavior.training.TrainingStatus" title="Link to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TrainingStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/brainbox/behavior/training.html#TrainingStatus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brainbox.behavior.training.TrainingStatus" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></p>
 <p>Standard IBL training criteria.</p>
 <p>Enumeration allows for comparisons between training status.</p>