-
Notifications
You must be signed in to change notification settings - Fork 0
/
boa.html
224 lines (200 loc) · 9.84 KB
/
boa.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
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
---
layout: default
title: projects
---
<section id="boa">
<div class="main-container" style="padding-top:8px;">
<h1>Boa Python Api</h1>
<h2 class="sub">A python api that will let users write queries using boa</h2>
<span class="underline"></span>
<h3><a href="https://github.com/boalang/api-python" style="color:#4070a0;">Link to project</a></h3>
<h2>Available Methods</h2>
<h3>Installing Package</h3>
<div class="code-box">
<span class="comment"># In Terminal</span>
<span class="code">>>> pip install boa-api</span>
</div>
<h3>login</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">log into the boa framework using the remote api</span>
<span class="keyword">Parameters:</span>
<span class="comment">username (`str): username for boa account</span>
<span class="comment">password (`str): password for boa account</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>datasets</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">Retrieves datasetsets currently provided by boa</span>
<span class="keyword">Parameters:</span>
<span class="comment"></span>
<span class="keyword">Returns:</span>
<span class="comment">(`list): a list of boa datasets</span>
</div>
<h3>close</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">Log out of the boa framework using the remote api</span>
<span class="keyword">Parameters:</span>
<span class="comment"></span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>dataset_names</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Retrieves a list of names of all datasets provided by boa</span>
<span class="keyword">Parameters:</span>
<span class="comment"></span>
<span class="keyword">Returns:</span>
<span class="comment">(`list): the names of available datasets</span>
</div>
<h3>get_dataset</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">Retrieves a dataset given a name.</span>
<span class="keyword">Parameters:</span>
<span class="comment">name (`str): The name of the input dataset to return.</span>
<span class="keyword">Returns:</span>
<span class="comment">(`dict): a dictionary with the keys id and name</span>
</div>
<h3>last_job</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">Retrieves the most recently submitted job</span>
<span class="keyword">Parameters:</span>
<span class="comment"></span>
<span class="keyword">Returns:</span>
<span class="comment">(`job_handle): the last submitted job</span>
</div>
<h3>job_count</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">Retrieves the number of jobs submitted by a user</span>
<span class="keyword">Parameters:</span>
<span class="comment">pub_only (`bool, optional): if true, return only public jobs
otherwise return all jobs</span>
<span class="keyword">Returns:</span>
<span class="comment">(`int) the number of jobs submitted by a user</span>
</div>
<h3>query</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">Submits a new query to Boa to query the specified and returns a handle to the new job.</span>
<span class="keyword">Parameters:</span>
<span class="comment">query (str): a boa query represented as a string.</span>
<span class="comment">dataset (str, optional): the name of the input dataset.</span>
<span class="keyword">Returns:</span>
<span class="comment">(`job_handle): the job with the generated from the given query</span>
</div>
<h3>get_job</h3>
<div class="code-box">
<span class="keyword">Description:</span>
<span class="comment">Retrieves a job given an id.</span>
<span class="keyword">Parameters:</span>
<span class="comment">id (int): the id of the job you want to retrieve </span>
<span class="keyword">Returns:</span>
<span class="comment">(`job_handle): the desired job.</span>
</div>
<h3>job_list</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment"></span>
<span class="keyword">Parameters</span>
<span class="comment">pub_only (`bool, optional): if true, only return public jobs otherwise return all jobs</span>
<span class="comment">offset (`int, optional): the starting offset</span>
<span class="comment">length (`int, optional): the number of jobs (at most) to return</span>
<span class="keyword">Returns:</span>
<span class="comment">list: a list of jobs</span>
</div>
<h3>stop</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Stops the execution of a job</span>
<span class="keyword">Parameters:</span>
<span class="comment">(`job_handle): the job whose execution you want to stop</span>
</div>
<h3>resubmit</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Resubmits a job to the framework</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
</div>
<h3>delete</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Deletes this job from the framework.</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>set_public</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Modifies the public/private status of this job.</span>
<span class="keyword">Parameters:</span>
<span class="comment">is_public (bool): 'True' to make it public, False to make it private</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>public_status</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Return the jobs public/private status.</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>get_url</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Retrieves the jobs URL.</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>public_url</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Get the jobs public page URL.</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>get_compiler_errors</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Return the output for this job, if it finished successfully and has an output.</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>source</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Return the source query for this job.</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
<h3>output</h3>
<div class="code-box">
<span class="keyword">Description</span>
<span class="comment">Return the output for this job, if it finished successfully and has an output.</span>
<span class="keyword">Parameters:</span>
<span class="comment">job (`job_handle)</span>
<span class="keyword">Returns:</span>
<span class="comment"></span>
</div>
</div>
</section>