Skip to content

Commit

Permalink
Update gh-pages to output generated at 5bd0a90
Browse files Browse the repository at this point in the history
  • Loading branch information
ktpolanski committed Nov 9, 2023
1 parent e814456 commit cd817e3
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion api.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
<tr class="row-even"><td><p><a class="reference internal" href="modules/sctk.generate_qc_clusters.html#sctk.generate_qc_clusters" title="sctk.generate_qc_clusters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">generate_qc_clusters</span></code></a>(ad, metrics[, aux_ad, ...])</p></td>
<td><p>Generate quality control (QC) clusters for an AnnData object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="modules/sctk.cellwise_qc.html#sctk.cellwise_qc" title="sctk.cellwise_qc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cellwise_qc</span></code></a>(adata[, metrics, cell_qc_key])</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="modules/sctk.cellwise_qc.html#sctk.cellwise_qc" title="sctk.cellwise_qc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cellwise_qc</span></code></a>(adata[, metrics, cell_qc_key, ...])</p></td>
<td><p>Filter cells in an AnnData object based on quality control metrics.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="modules/sctk.clusterwise_qc.html#sctk.clusterwise_qc" title="sctk.clusterwise_qc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clusterwise_qc</span></code></a>(ad[, threshold, cell_qc_key, ...])</p></td>
Expand Down
3 changes: 2 additions & 1 deletion modules/sctk.cellwise_qc.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<h1>sctk.cellwise_qc<a class="headerlink" href="#sctk-cellwise-qc" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="sctk.cellwise_qc">
<span class="sig-prename descclassname"><span class="pre">sctk.</span></span><span class="sig-name descname"><span class="pre">cellwise_qc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics</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">cell_qc_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'cell_passed_qc'</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><a class="headerlink" href="#sctk.cellwise_qc" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">sctk.</span></span><span class="sig-name descname"><span class="pre">cellwise_qc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics</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">cell_qc_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'cell_passed_qc'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uns_qc_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'scautoqc_ranges'</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><a class="headerlink" href="#sctk.cellwise_qc" title="Permalink to this definition"></a></dt>
<dd><p>Filter cells in an AnnData object based on quality control metrics. The
object is modified in-place.</p>
<p>This function filters cells in an AnnData object based on quality control
Expand All @@ -135,6 +135,7 @@ <h1>sctk.cellwise_qc<a class="headerlink" href="#sctk-cellwise-qc" title="Permal
uses a set of default metrics. For defaults and an explanation, please
refer to the QC workflow demo notebook.</p></li>
<li><p><strong>cell_qc_key</strong> – Obs column in the object to store the per-cell QC calls in.</p></li>
<li><p><strong>uns_qc_key</strong> – Uns key to store the determined QC ranges used in filtering.</p></li>
<li><p><strong>**kwargs</strong> – Additional keyword arguments to pass to the
<code class="xref py py-func docutils literal notranslate"><span class="pre">fit_gaussian()</span></code> function.</p></li>
</ul>
Expand Down
Loading

0 comments on commit cd817e3

Please sign in to comment.