Log In Sign Up
Models:
Daniel Galbraith
DanielG/
scPanel
0
Downloads: 1
[f3902c]: / docs / build / html / autoapi / scpanel / train / index.html

Download this file

293 lines (259 with data), 42.6 kB 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<!DOCTYPE html>

<html class="writer-html5" lang="en" data-content_root="../../../">

<head>

  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />



  <meta name="viewport" content="width=device-width, initial-scale=1.0" />

  <title>scpanel.train &mdash; scPanel 0.1.0 documentation</title>

      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />

      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />

      <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=fd3f3429" />



  

      <script src="../../../_static/jquery.js?v=5d32c60e"></script>

      <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>

      <script src="../../../_static/documentation_options.js?v=01f34227"></script>

      <script src="../../../_static/doctools.js?v=9a2dae69"></script>

      <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>

      <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

    <script src="../../../_static/js/theme.js"></script>

    <link rel="index" title="Index" href="../../../genindex.html" />

    <link rel="search" title="Search" href="../../../search.html" />

    <link rel="next" title="scpanel.utils_func" href="../utils_func/index.html" />

    <link rel="prev" title="scpanel.split_patient" href="../split_patient/index.html" /> 

</head>



<body class="wy-body-for-nav"> 

  <div class="wy-grid-for-nav">

    <nav data-toggle="wy-nav-shift" class="wy-nav-side">

      <div class="wy-side-scroll">

        <div class="wy-side-nav-search" >



          

          

          <a href="../../../index.html" class="icon icon-home">

            scPanel

          </a>

<div role="search">

  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">

    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />

    <input type="hidden" name="check_keywords" value="yes" />

    <input type="hidden" name="area" value="default" />

  </form>

</div>

        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>

<ul class="current">

<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">API Reference</a><ul class="current">

<li class="toctree-l2 current"><a class="reference internal" href="../index.html">scpanel</a><ul class="current">

<li class="toctree-l3 current"><a class="reference internal" href="../index.html#submodules">Submodules</a><ul class="current">

<li class="toctree-l4"><a class="reference internal" href="../GATclassifier/index.html">scpanel.GATclassifier</a></li>

<li class="toctree-l4"><a class="reference internal" href="../SVMRFECV/index.html">scpanel.SVMRFECV</a></li>

<li class="toctree-l4"><a class="reference internal" href="../palettes/index.html">scpanel.palettes</a></li>

<li class="toctree-l4"><a class="reference internal" href="../select_cell/index.html">scpanel.select_cell</a></li>

<li class="toctree-l4"><a class="reference internal" href="../select_gene/index.html">scpanel.select_gene</a></li>

<li class="toctree-l4"><a class="reference internal" href="../settings/index.html">scpanel.settings</a></li>

<li class="toctree-l4"><a class="reference internal" href="../split_patient/index.html">scpanel.split_patient</a></li>

<li class="toctree-l4 current"><a class="current reference internal" href="#">scpanel.train</a></li>

<li class="toctree-l4"><a class="reference internal" href="../utils_func/index.html">scpanel.utils_func</a></li>

</ul>

</li>

</ul>

</li>

</ul>

</li>

</ul>



        </div>

      </div>

    </nav>



    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >

          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>

          <a href="../../../index.html">scPanel</a>

      </nav>



      <div class="wy-nav-content">

        <div class="rst-content">

          <div role="navigation" aria-label="Page navigation">

  <ul class="wy-breadcrumbs">

      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>

          <li class="breadcrumb-item"><a href="../../index.html">API Reference</a></li>

          <li class="breadcrumb-item"><a href="../index.html">scpanel</a></li>

      <li class="breadcrumb-item active">scpanel.train</li>

      <li class="wy-breadcrumbs-aside">

            <a href="../../../_sources/autoapi/scpanel/train/index.rst.txt" rel="nofollow"> View page source</a>

      </li>

  </ul>

  <hr/>

</div>

          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">

           <div itemprop="articleBody">

             

  <section id="module-scpanel.train">

<span id="scpanel-train"></span><h1>scpanel.train<a class="headerlink" href="#module-scpanel.train" title="Link to this heading"></a></h1>

<section id="functions">

<h2>Functions<a class="headerlink" href="#functions" title="Link to this heading"></a></h2>

<table class="autosummary longtable docutils align-default">

<tbody>

<tr class="row-odd"><td><p><a class="reference internal" href="#scpanel.train.transform_adata" title="scpanel.train.transform_adata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transform_adata</span></code></a>(→ Tuple[anndata._core.anndata.AnnData, ...)</p></td>

<td><p></p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="#scpanel.train.models_train" title="scpanel.train.models_train"><code class="xref py py-obj docutils literal notranslate"><span class="pre">models_train</span></code></a>(→ List[Union[Tuple[str, ...)</p></td>

<td><p></p></td>

</tr>

<tr class="row-odd"><td><p><a class="reference internal" href="#scpanel.train.models_predict" title="scpanel.train.models_predict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">models_predict</span></code></a>(→ Tuple[anndata._core.anndata.AnnData, ...)</p></td>

<td><p></p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="#scpanel.train.models_score" title="scpanel.train.models_score"><code class="xref py py-obj docutils literal notranslate"><span class="pre">models_score</span></code></a>(adata_test_final, y_pred_list, ...[, out_dir])</p></td>

<td><p></p></td>

</tr>

<tr class="row-odd"><td><p><a class="reference internal" href="#scpanel.train.cal_sample_auc" title="scpanel.train.cal_sample_auc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cal_sample_auc</span></code></a>(→ numpy.float64)</p></td>

<td><p></p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="#scpanel.train.auc_pvalue" title="scpanel.train.auc_pvalue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">auc_pvalue</span></code></a>(→ float)</p></td>

<td><p></p></td>

</tr>

<tr class="row-odd"><td><p><a class="reference internal" href="#scpanel.train.pt_pred" title="scpanel.train.pt_pred"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pt_pred</span></code></a>(→ anndata._core.anndata.AnnData)</p></td>

<td><p></p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="#scpanel.train.pt_score" title="scpanel.train.pt_score"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pt_score</span></code></a>(→ anndata._core.anndata.AnnData)</p></td>

<td><p></p></td>

</tr>

<tr class="row-odd"><td><p><a class="reference internal" href="#scpanel.train._panel_grid" title="scpanel.train._panel_grid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_panel_grid</span></code></a>(→ Tuple[matplotlib.figure.Figure, ...)</p></td>

<td><p></p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="#scpanel.train.plot_roc_curve" title="scpanel.train.plot_roc_curve"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_roc_curve</span></code></a>(→ List[matplotlib.axes._axes.Axes])</p></td>

<td><p></p></td>

</tr>

<tr class="row-odd"><td><p><a class="reference internal" href="#scpanel.train.convert_pvalue_to_asterisks" title="scpanel.train.convert_pvalue_to_asterisks"><code class="xref py py-obj docutils literal notranslate"><span class="pre">convert_pvalue_to_asterisks</span></code></a>(→ str)</p></td>

<td><p></p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="#scpanel.train.plot_violin" title="scpanel.train.plot_violin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_violin</span></code></a>(→ matplotlib.axes._axes.Axes)</p></td>

<td><p>Violin Plots for cell-level prediction probabilities in each sample.</p></td>

</tr>

<tr class="row-odd"><td><p><a class="reference internal" href="#scpanel.train.make_single_spider" title="scpanel.train.make_single_spider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_single_spider</span></code></a>(→ None)</p></td>

<td><p></p></td>

</tr>

</tbody>

</table>

</section>

<section id="module-contents">

<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading"></a></h2>

<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.transform_adata">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">transform_adata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adata_test_dict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">anndata._core.anndata.AnnData</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selected_gene</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">anndata._core.anndata.AnnData</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">anndata._core.anndata.AnnData</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#scpanel.train.transform_adata" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.models_train">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">models_train</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata_train_final</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">search_grid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">out_dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_grid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.linear_model._logistic.LogisticRegression</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.ensemble._forest.RandomForestClassifier</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.svm._classes.SVC</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.neighbors._classification.KNeighborsClassifier</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../GATclassifier/index.html#scpanel.GATclassifier.GATclassifier" title="scpanel.GATclassifier.GATclassifier"><span class="pre">scpanel.GATclassifier.GATclassifier</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#scpanel.train.models_train" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.models_predict">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">models_predict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clfs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.linear_model._logistic.LogisticRegression</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.ensemble._forest.RandomForestClassifier</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.svm._classes.SVC</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">sklearn.neighbors._classification.KNeighborsClassifier</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../GATclassifier/index.html#scpanel.GATclassifier.GATclassifier" title="scpanel.GATclassifier.GATclassifier"><span class="pre">scpanel.GATclassifier.GATclassifier</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adata_test_final</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">out_dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">anndata._core.anndata.AnnData</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#scpanel.train.models_predict" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.models_score">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">models_score</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata_test_final</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred_score_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">out_dir</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="headerlink" href="#scpanel.train.models_score" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.cal_sample_auc">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">cal_sample_auc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pandas.core.frame.DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">score_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">numpy.float64</span></span></span><a class="headerlink" href="#scpanel.train.cal_sample_auc" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.auc_pvalue">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">auc_pvalue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">row</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pandas.core.series.Series</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">float</span></span></span><a class="headerlink" href="#scpanel.train.auc_pvalue" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.pt_pred">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">pt_pred</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata_test_final</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_pred_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'median_pred_score'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_bootstrap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">anndata._core.anndata.AnnData</span></span></span><a class="headerlink" href="#scpanel.train.pt_pred" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.pt_score">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">pt_score</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata_test_final</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_pred_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'median_pred_score'</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">anndata._core.anndata.AnnData</span></span></span><a class="headerlink" href="#scpanel.train.pt_score" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train._panel_grid">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">_panel_grid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hspace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wspace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_panels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">matplotlib.figure.Figure</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">matplotlib.gridspec.GridSpec</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#scpanel.train._panel_grid" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.plot_roc_curve">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">plot_roc_curve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata_test_final</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pandas.core.series.Series</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_pred_col</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="n"><span class="pre">ncols</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hspace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.25</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wspace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ax</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scatter_kws</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legend_kws</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">List</span><span class="p"><span class="pre">[</span></span><span class="pre">matplotlib.axes._axes.Axes</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#scpanel.train.plot_roc_curve" title="Link to this definition"></a></dt>

<dd><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>adata_test_final</strong> (<em>-</em>)</p></li>

<li><p><strong>sample_id</strong> (<em>-</em>)</p></li>

<li><p><strong>cell_pred_col</strong> (<em>-</em>)</p></li>

<li><p><strong>ncols</strong> (<em>-</em>)</p></li>

<li><p><strong>hspace</strong> (<em>-</em>)</p></li>

<li><p><strong>wspace</strong> (<em>-</em>)</p></li>

<li><p><strong>ax</strong> (<em>-</em>)</p></li>

<li><p><strong>scatter_kws</strong> (<em>-</em>)</p></li>

</ul>

</dd>

<dt class="field-even">Return type<span class="colon">:</span></dt>

<dd class="field-even"><p>Axes</p>

</dd>

</dl>

<p class="rubric">Examples</p>

<dl class="simple">

<dt>plot_roc_curve(adata_test_final,</dt><dd><p>sample_id = [‘C3’,’C6’,’H1’],

cell_pred_col = ‘median_pred_score’,

scatter_kws={‘s’:10})</p>

</dd>

</dl>

</dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.convert_pvalue_to_asterisks">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">convert_pvalue_to_asterisks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pvalue</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">str</span></span></span><a class="headerlink" href="#scpanel.train.convert_pvalue_to_asterisks" title="Link to this definition"></a></dt>

<dd></dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.plot_violin">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">plot_violin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_pred_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'median_pred_score'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ax</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">matplotlib.axes._axes.Axes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">palette</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xticklabels_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text_kws</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</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">matplotlib.axes._axes.Axes</span></span></span><a class="headerlink" href="#scpanel.train.plot_violin" title="Link to this definition"></a></dt>

<dd><p>Violin Plots for cell-level prediction probabilities in each sample.</p>

<p>Parameters:

- adata: AnnData Object</p>

<ul class="simple">

<li><p>cell_pred_col: string, name of the column with cell-level prediction probabilities</p></li>

</ul>

<p>in adata.obs (default: ‘median_pred_score’)</p>

<ul class="simple">

<li><p>pt_stat: string, a test for the null hypothesis that the distribution of probabilities</p></li>

</ul>

<dl class="simple">

<dt>in this sample is different from the population (default: ‘perm’)</dt><dd><p>Options:

- ‘perm’: permutation test

- ‘t-test’: one-sample t-test</p>

</dd>

</dl>

<ul class="simple">

<li><p>fig_size: tuple, size of figure (default: (10, 3))</p></li>

<li><p>dot_size: float, Radius of the markers in stripplot.</p></li>

</ul>

<dl class="field-list simple">

<dt class="field-odd">Returns<span class="colon">:</span></dt>

<dd class="field-odd"><p>ax</p>

</dd>

</dl>

</dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="scpanel.train.make_single_spider">

<span class="sig-prename descclassname"><span class="pre">scpanel.train.</span></span><span class="sig-name descname"><span class="pre">make_single_spider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adata_test_final</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">anndata._core.anndata.AnnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</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="n"><span class="pre">nrow</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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="headerlink" href="#scpanel.train.make_single_spider" title="Link to this definition"></a></dt>

<dd></dd></dl>



</section>

</section>





           </div>

          </div>

          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">

        <a href="../split_patient/index.html" class="btn btn-neutral float-left" title="scpanel.split_patient" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>

        <a href="../utils_func/index.html" class="btn btn-neutral float-right" title="scpanel.utils_func" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>

    </div>



  <hr/>



  <div role="contentinfo">

    <p>&#169; Copyright 2024, Yi Carissa Xie.</p>

  </div>



  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

    provided by <a href="https://readthedocs.org">Read the Docs</a>.

   



</footer>

        </div>

      </div>

    </section>

  </div>

  <script>

      jQuery(function () {

          SphinxRtdTheme.Navigation.enable(true);

      });

  </script> 



</body>

</html>