-
Notifications
You must be signed in to change notification settings - Fork 5
/
spapros.ev.ProbesetEvaluator.plot_summary.html
193 lines (171 loc) · 14.8 KB
/
spapros.ev.ProbesetEvaluator.plot_summary.html
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
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>spapros.ev.ProbesetEvaluator.plot_summary — spapros docs</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/custom_cookietemple.css" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/general.css" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/dark.css" />
<link rel="shortcut icon" href="../_static/logo.png"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></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="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
<script src="../_static/dark_mode_js/default_light.js"></script>
<script src="../_static/dark_mode_js/theme_switcher.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="spapros.ev.ProbesetEvaluator.summary_statistics" href="spapros.ev.ProbesetEvaluator.summary_statistics.html" />
<link rel="prev" title="spapros.ev.ProbesetEvaluator.plot_marker_corr" href="spapros.ev.ProbesetEvaluator.plot_marker_corr.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">
spapros
<img src="../_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.1.5
</div>
<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"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../api.html#module-spapros.se">Selection</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html#module-spapros.ev">Evaluation</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.html">spapros.ev.ProbesetEvaluator</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.html#spapros.ev.ProbesetEvaluator"><code class="docutils literal notranslate"><span class="pre">ProbesetEvaluator</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.compute_or_load_shared_results.html">spapros.ev.ProbesetEvaluator.compute_or_load_shared_results</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.evaluate_probeset.html">spapros.ev.ProbesetEvaluator.evaluate_probeset</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.evaluate_probeset_pipeline.html">spapros.ev.ProbesetEvaluator.evaluate_probeset_pipeline</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.load_results.html">spapros.ev.ProbesetEvaluator.load_results</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.pipeline_summary_statistics.html">spapros.ev.ProbesetEvaluator.pipeline_summary_statistics</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.plot_cluster_similarity.html">spapros.ev.ProbesetEvaluator.plot_cluster_similarity</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.plot_coexpression.html">spapros.ev.ProbesetEvaluator.plot_coexpression</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.plot_confusion_matrix.html">spapros.ev.ProbesetEvaluator.plot_confusion_matrix</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.plot_evaluations.html">spapros.ev.ProbesetEvaluator.plot_evaluations</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.plot_knn_overlap.html">spapros.ev.ProbesetEvaluator.plot_knn_overlap</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.plot_marker_corr.html">spapros.ev.ProbesetEvaluator.plot_marker_corr</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">spapros.ev.ProbesetEvaluator.plot_summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="spapros.ev.ProbesetEvaluator.summary_statistics.html">spapros.ev.ProbesetEvaluator.summary_statistics</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spapros.ev.get_metric_default_parameters.html">spapros.ev.get_metric_default_parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="spapros.ev.forest_classifications.html">spapros.ev.forest_classifications</a></li>
<li class="toctree-l3"><a class="reference internal" href="spapros.ev.single_forest_classifications.html">spapros.ev.single_forest_classifications</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#module-spapros.ut">Utility functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#plotting">Plotting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../authors.html">Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_of_conduct.html">Contributor Covenant Code of Conduct</a></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">spapros</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="../api.html">API</a></li>
<li class="breadcrumb-item"><a href="spapros.ev.ProbesetEvaluator.html">spapros.ev.ProbesetEvaluator</a></li>
<li class="breadcrumb-item active">spapros.ev.ProbesetEvaluator.plot_summary</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/ev/spapros.ev.ProbesetEvaluator.plot_summary.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="spapros-ev-probesetevaluator-plot-summary">
<h1>spapros.ev.ProbesetEvaluator.plot_summary<a class="headerlink" href="#spapros-ev-probesetevaluator-plot-summary" title="Permalink to this heading"></a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="spapros.ev.ProbesetEvaluator.plot_summary">
<span class="sig-prename descclassname"><span class="pre">ProbesetEvaluator.</span></span><span class="sig-name descname"><span class="pre">plot_summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">set_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">plot_kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#spapros.ev.ProbesetEvaluator.plot_summary" title="Permalink to this definition"></a></dt>
<dd><p>Plot heatmap of summary metrics</p>
<p>See our basic evaluation tutorial for descriptions of each metric.</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>set_ids</strong> (<em>Union</em><em>[</em><em>str</em><em>, </em><em>List</em><em>[</em><em>str</em><em>]</em><em>]</em>) – IDs of the current probesets or “all”. Check out <code class="xref py py-attr docutils literal notranslate"><span class="pre">ProbesetEvaluator.summary_results</span></code> for
available sets.</p></li>
<li><p><strong>**plot_kwargs</strong> – Keyword arguments for <a class="reference internal" href="../pl/spapros.pl.summary_table.html#spapros.pl.summary_table" title="spapros.pl.summary_table"><code class="xref py py-func docutils literal notranslate"><span class="pre">summary_table()</span></code></a>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
<p class="rubric">Example</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">spapros</span> <span class="k">as</span> <span class="nn">sp</span>
<span class="n">adata</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">ut</span><span class="o">.</span><span class="n">get_processed_pbmc_data</span><span class="p">()</span>
<span class="n">selections</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">se</span><span class="o">.</span><span class="n">select_reference_probesets</span><span class="p">(</span>
<span class="n">adata</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s2">"PCA"</span><span class="p">,</span> <span class="s2">"DE"</span><span class="p">,</span> <span class="s2">"HVG"</span><span class="p">,</span> <span class="s2">"random"</span><span class="p">],</span> <span class="n">n</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> <span class="n">verbosity</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="n">evaluator</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">ev</span><span class="o">.</span><span class="n">ProbesetEvaluator</span><span class="p">(</span><span class="n">adata</span><span class="p">,</span> <span class="n">verbosity</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">results_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="k">for</span> <span class="n">set_id</span><span class="p">,</span> <span class="n">df</span> <span class="ow">in</span> <span class="n">selections</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">gene_set</span> <span class="o">=</span> <span class="n">df</span><span class="p">[</span><span class="n">df</span><span class="p">[</span><span class="s2">"selection"</span><span class="p">]]</span><span class="o">.</span><span class="n">index</span><span class="o">.</span><span class="n">to_list</span><span class="p">()</span>
<span class="n">evaluator</span><span class="o">.</span><span class="n">evaluate_probeset</span><span class="p">(</span><span class="n">gene_set</span><span class="p">,</span> <span class="n">set_id</span><span class="o">=</span><span class="n">set_id</span><span class="p">)</span>
<span class="n">evaluator</span><span class="o">.</span><span class="n">plot_summary</span><span class="p">(</span><span class="n">set_ids</span><span class="o">=</span><span class="p">[</span><span class="s2">"PCA"</span><span class="p">,</span> <span class="s2">"DE"</span><span class="p">,</span> <span class="s2">"HVG"</span><span class="p">,</span> <span class="s2">"random (seed=0)"</span><span class="p">])</span>
</pre></div>
</div>
<img alt="../_images/Evaluator_plot_summary.png" src="../_images/Evaluator_plot_summary.png" />
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="spapros.ev.ProbesetEvaluator.plot_marker_corr.html" class="btn btn-neutral float-left" title="spapros.ev.ProbesetEvaluator.plot_marker_corr" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="spapros.ev.ProbesetEvaluator.summary_statistics.html" class="btn btn-neutral float-right" title="spapros.ev.ProbesetEvaluator.summary_statistics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2022, Lukas Heumos.</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>