-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAPI.html
149 lines (125 loc) · 5.91 KB
/
API.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Python APIs created for this project — OncoTree 1.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="OncoTree 1.0 documentation" href="index.html" />
<link rel="prev" title="Welcome to OncoTree’s documentation!" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="python-apis-created-for-this-project">
<h1>Python APIs created for this project<a class="headerlink" href="#python-apis-created-for-this-project" title="Permalink to this headline">¶</a></h1>
<div class="section" id="oncotree-module">
<h2>OncoTree module<a class="headerlink" href="#oncotree-module" title="Permalink to this headline">¶</a></h2>
<div class="section" id="oncotree-class">
<span id="oncotree"></span><h3>OncoTree class<a class="headerlink" href="#oncotree-class" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="OncoTree.OncoTree.OncoTree">
<em class="property">class </em><code class="descclassname">OncoTree.OncoTree.</code><code class="descname">OncoTree</code><span class="sig-paren">(</span><em>file_path=False</em><span class="sig-paren">)</span><a class="headerlink" href="#OncoTree.OncoTree.OncoTree" title="Permalink to this definition">¶</a></dt>
<dd><p>A OncoGxOne class to consume a tab delimited table of cancer type and construct tree structure class</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">OncoTree</span> <span class="k">import</span> <span class="o">*</span>
</pre></div>
</div>
<dl class="method">
<dt id="OncoTree.OncoTree.OncoTree.distance">
<code class="descname">distance</code><span class="sig-paren">(</span><em>cop</em>, <em>coc</em><span class="sig-paren">)</span><a class="headerlink" href="#OncoTree.OncoTree.OncoTree.distance" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to calculate distance between two input cancer types</p>
</dd></dl>
<dl class="method">
<dt id="OncoTree.OncoTree.OncoTree.homo">
<code class="descname">homo</code><span class="sig-paren">(</span><em>cop</em>, <em>coc</em><span class="sig-paren">)</span><a class="headerlink" href="#OncoTree.OncoTree.OncoTree.homo" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to check if two input cancer types in the same lineage</p>
</dd></dl>
<dl class="method">
<dt id="OncoTree.OncoTree.OncoTree.inclusion">
<code class="descname">inclusion</code><span class="sig-paren">(</span><em>cop</em><span class="sig-paren">)</span><a class="headerlink" href="#OncoTree.OncoTree.OncoTree.inclusion" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to check if cancer type exist in oncotree</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Python APIs created for this project</a><ul>
<li><a class="reference internal" href="#oncotree-module">OncoTree module</a><ul>
<li><a class="reference internal" href="#oncotree-class">OncoTree class</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to OncoTree’s documentation!</a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/API.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017, Cheng Yan.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.5</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
|
<a href="_sources/API.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>