DOCS: update

nilomr · May 7, 2022 · 4a2ed4a · 4a2ed4a
1 parent d85b8a4
commit 4a2ed4a
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 20 deletions.
diff --git a/docs/contents/basic-workflow.ipynb b/docs/contents/basic-workflow.ipynb
@@ -352,7 +352,7 @@
                 "\n",
                 "# Plot an example:\n",
                 "for vocalisation in dataset.vocs.index[:1]:\n",
-                "    dataset.plot_voc_seg(vocalisation)"
+                "    dataset.plot_segments(vocalisation)"
             ]
         },
         {
@@ -506,4 +506,4 @@
     },
     "nbformat": 4,
     "nbformat_minor": 2
-}
+}
diff --git a/docs/contents/kantodata-dataset.ipynb b/docs/contents/kantodata-dataset.ipynb
@@ -45,7 +45,7 @@
     "    :linenos:\n",
     "\n",
     "    # Plot some information about the dataset\n",
-    "    dataset.summary_plot(variable='all')\n",
+    "    dataset.plot_summary(variable='all')\n",
     "\n",
     "\n",
     "Check sample size per individual ID in the dataset:\n",

diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/html/_autosummary/pykanto.dataset.html b/docs/html/_autosummary/pykanto.dataset.html
@@ -739,8 +739,8 @@ <h1>pykanto.dataset</h1>
 </dd></dl>
 
 <dl class="py method">
-<dt class="sig sig-object py" id="pykanto.dataset.KantoData.plot_voc_seg">
-<span class="sig-name descname"><span class="pre">plot_voc_seg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/pykanto/dataset.html#KantoData.plot_voc_seg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pykanto.dataset.KantoData.plot_voc_seg" title="Permalink to this definition">#</a></dt>
+<dt class="sig sig-object py" id="pykanto.dataset.KantoData.plot_segments">
+<span class="sig-name descname"><span class="pre">plot_segments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/pykanto/dataset.html#KantoData.plot_segments"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pykanto.dataset.KantoData.plot_segments" title="Permalink to this definition">#</a></dt>
 <dd><p>Plots a vocalisation and overlays the results
 of the segmentation process.</p>
 <dl class="field-list simple">

diff --git a/docs/html/_modules/pykanto/dataset.html b/docs/html/_modules/pykanto/dataset.html
@@ -1217,7 +1217,7 @@ <h1>Source code for pykanto.dataset</h1><div class="highlight"><pre>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">DIRS</span><span class="o">.</span><span class="n">DATASET</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">))</span></div>
 
-<div class="viewcode-block" id="KantoData.plot_voc_seg"><a class="viewcode-back" href="../../_autosummary/pykanto.dataset.html#pykanto.dataset.KantoData.plot_voc_seg">[docs]</a>    <span class="k">def</span> <span class="nf">plot_voc_seg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<div class="viewcode-block" id="KantoData.plot_segments"><a class="viewcode-back" href="../../_autosummary/pykanto.dataset.html#pykanto.dataset.KantoData.plot_segments">[docs]</a>    <span class="k">def</span> <span class="nf">plot_segments</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Plots a vocalisation and overlays the results</span>
 <span class="sd">        of the segmentation process.</span>

diff --git a/docs/html/_sources/contents/basic-workflow.ipynb.txt b/docs/html/_sources/contents/basic-workflow.ipynb.txt
@@ -352,7 +352,7 @@
                 "\n",
                 "# Plot an example:\n",
                 "for vocalisation in dataset.vocs.index[:1]:\n",
-                "    dataset.plot_voc_seg(vocalisation)"
+                "    dataset.plot_segments(vocalisation)"
             ]
         },
         {

diff --git a/docs/html/_sources/contents/kantodata-dataset.ipynb.txt b/docs/html/_sources/contents/kantodata-dataset.ipynb.txt
@@ -45,7 +45,7 @@
     "    :linenos:\n",
     "\n",
     "    # Plot some information about the dataset\n",
-    "    dataset.summary_plot(variable='all')\n",
+    "    dataset.plot_summary(variable='all')\n",
     "\n",
     "\n",
     "Check sample size per individual ID in the dataset:\n",

diff --git a/docs/html/contents/basic-workflow.html b/docs/html/contents/basic-workflow.html
diff --git a/docs/html/contents/kantodata-dataset.html b/docs/html/contents/kantodata-dataset.html
@@ -514,7 +514,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
 <p>.. code-block:: python
 :linenos:</p>
 <div class="highlight-none notranslate"><div class="highlight"><pre><span></span># Plot some information about the dataset
-dataset.summary_plot(variable=&#39;all&#39;)
+dataset.plot_summary(variable=&#39;all&#39;)
 </pre></div>
 </div>
 <p>Check sample size per individual ID in the dataset:</p>

diff --git a/docs/html/contents/segmenting-files.html b/docs/html/contents/segmenting-files.html
diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -881,7 +881,7 @@ <h2 id="P">P</h2>
 </li>
       <li><a href="_autosummary/pykanto.utils.custom.html#pykanto.utils.custom.parse_sonic_visualiser_xml">parse_sonic_visualiser_xml() (in module pykanto.utils.custom)</a>
 </li>
-      <li><a href="_autosummary/pykanto.dataset.html#pykanto.dataset.KantoData.plot_voc_seg">plot_voc_seg() (pykanto.dataset.KantoData method)</a>
+      <li><a href="_autosummary/pykanto.dataset.html#pykanto.dataset.KantoData.plot_segments">plot_segments() (pykanto.dataset.KantoData method)</a>
 </li>
       <li><a href="_autosummary/pykanto.labelapp.data.html#pykanto.labelapp.data.prepare_datasource">prepare_datasource() (in module pykanto.labelapp.data)</a>
 </li>

diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js