pyxetabase 3.1.0.dev21__py3-none-any.whl → 4.0.0.dev29__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. pyxetabase/opencga_config.py +29 -0
  2. pyxetabase/rest_clients/_parent_rest_clients.py +47 -13
  3. pyxetabase/rest_clients/admin_client.py +1 -2
  4. pyxetabase/rest_clients/meta_client.py +4 -3
  5. pyxetabase/rest_clients/study_client.py +28 -0
  6. pyxetabase/rest_clients/variant_operation_client.py +26 -27
  7. {pyxetabase-3.1.0.dev21.dist-info → pyxetabase-4.0.0.dev29.dist-info}/METADATA +1 -1
  8. pyxetabase-4.0.0.dev29.dist-info/RECORD +35 -0
  9. pyopencga/__init__.py +0 -0
  10. pyopencga/commons.py +0 -347
  11. pyopencga/exceptions.py +0 -8
  12. pyopencga/opencga_client.py +0 -334
  13. pyopencga/opencga_config.py +0 -182
  14. pyopencga/rest_clients/__init__.py +0 -0
  15. pyopencga/rest_clients/_parent_rest_clients.py +0 -110
  16. pyopencga/rest_clients/admin_client.py +0 -173
  17. pyopencga/rest_clients/alignment_client.py +0 -373
  18. pyopencga/rest_clients/clinical_analysis_client.py +0 -1279
  19. pyopencga/rest_clients/cohort_client.py +0 -338
  20. pyopencga/rest_clients/disease_panel_client.py +0 -352
  21. pyopencga/rest_clients/family_client.py +0 -355
  22. pyopencga/rest_clients/file_client.py +0 -698
  23. pyopencga/rest_clients/ga4gh_client.py +0 -86
  24. pyopencga/rest_clients/individual_client.py +0 -435
  25. pyopencga/rest_clients/job_client.py +0 -415
  26. pyopencga/rest_clients/meta_client.py +0 -85
  27. pyopencga/rest_clients/organization_client.py +0 -216
  28. pyopencga/rest_clients/project_client.py +0 -128
  29. pyopencga/rest_clients/sample_client.py +0 -446
  30. pyopencga/rest_clients/study_client.py +0 -433
  31. pyopencga/rest_clients/user_client.py +0 -192
  32. pyopencga/rest_clients/variant_client.py +0 -1378
  33. pyopencga/rest_clients/variant_operation_client.py +0 -719
  34. pyopencga/rest_clients/workflow_client.py +0 -263
  35. pyopencga/rest_response.py +0 -220
  36. pyopencga/retry.py +0 -57
  37. pyxetabase-3.1.0.dev21.dist-info/RECORD +0 -63
  38. {pyxetabase-3.1.0.dev21.dist-info → pyxetabase-4.0.0.dev29.dist-info}/WHEEL +0 -0
  39. {pyxetabase-3.1.0.dev21.dist-info → pyxetabase-4.0.0.dev29.dist-info}/licenses/LICENSE +0 -0
  40. {pyxetabase-3.1.0.dev21.dist-info → pyxetabase-4.0.0.dev29.dist-info}/top_level.txt +0 -0
@@ -1,719 +0,0 @@
1
- """
2
- WARNING: AUTOGENERATED CODE
3
-
4
- This code was generated by a tool.
5
-
6
- Manual changes to this file may cause unexpected behavior in your application.
7
- Manual changes to this file will be overwritten if the code is regenerated.
8
- """
9
-
10
- from pyopencga.rest_clients._parent_rest_clients import _ParentRestClient
11
-
12
-
13
- class VariantOperation(_ParentRestClient):
14
- """
15
- This class contains methods for the 'Operations - Variant Storage' webservices
16
- PATH: /{apiVersion}/operation
17
- """
18
-
19
- def __init__(self, configuration, token=None, login_handler=None, *args, **kwargs):
20
- super(VariantOperation, self).__init__(configuration, token, login_handler, *args, **kwargs)
21
-
22
- def configure_cellbase(self, data=None, **options):
23
- """
24
- Update Cellbase configuration.
25
- PATH: /{apiVersion}/operation/cellbase/configure
26
-
27
- :param str project: Project [organization@]project where project can
28
- be either the ID or the alias.
29
- :param bool annotation_update: Create and load variant annotations
30
- into the database.
31
- :param str annotation_save_id: Save a copy of the current variant
32
- annotation at the database.
33
- :param dict data: New cellbase configuration.
34
- """
35
-
36
- return self._post(category='operation', resource='configure', subcategory='cellbase', data=data, **options)
37
-
38
- def aggregate_variant(self, data=None, **options):
39
- """
40
- Find variants where not all the samples are present, and fill the
41
- empty values, excluding HOM-REF (0/0) values.
42
- PATH: /{apiVersion}/operation/variant/aggregate
43
-
44
- :param str job_id: Job ID. It must be a unique string within the
45
- study. An ID will be autogenerated automatically if not provided.
46
- :param str job_description: Job description.
47
- :param str job_depends_on: Comma separated list of existing job IDs
48
- the job will depend on.
49
- :param str job_tags: Job tags.
50
- :param str job_scheduled_start_time: Time when the job is scheduled to
51
- start.
52
- :param str job_priority: Priority of the job.
53
- :param bool job_dry_run: Flag indicating that the job will be executed
54
- in dry-run mode. In this mode, OpenCGA will validate that all
55
- parameters and prerequisites are correctly set for successful
56
- execution, but the job will not actually run.
57
- :param str study: Study [[organization@]project:]study where study and
58
- project can be either the ID or UUID.
59
- :param dict data: Variant aggregate params.
60
- """
61
-
62
- return self._post(category='operation', resource='aggregate', subcategory='variant', data=data, **options)
63
-
64
- def delete_variant_annotation(self, **options):
65
- """
66
- Deletes a saved copy of variant annotation.
67
- PATH: /{apiVersion}/operation/variant/annotation/delete
68
-
69
- :param str job_id: Job ID. It must be a unique string within the
70
- study. An ID will be autogenerated automatically if not provided.
71
- :param str job_description: Job description.
72
- :param str job_depends_on: Comma separated list of existing job IDs
73
- the job will depend on.
74
- :param str job_tags: Job tags.
75
- :param str job_scheduled_start_time: Time when the job is scheduled to
76
- start.
77
- :param str job_priority: Priority of the job.
78
- :param bool job_dry_run: Flag indicating that the job will be executed
79
- in dry-run mode. In this mode, OpenCGA will validate that all
80
- parameters and prerequisites are correctly set for successful
81
- execution, but the job will not actually run.
82
- :param str project: Project [organization@]project where project can
83
- be either the ID or the alias.
84
- :param str annotation_id: Annotation identifier.
85
- """
86
-
87
- return self._delete(category='operation', resource='delete', subcategory='variant/annotation', **options)
88
-
89
- def index_variant_annotation(self, data=None, **options):
90
- """
91
- Create and load variant annotations into the database.
92
- PATH: /{apiVersion}/operation/variant/annotation/index
93
-
94
- :param str job_id: Job ID. It must be a unique string within the
95
- study. An ID will be autogenerated automatically if not provided.
96
- :param str job_description: Job description.
97
- :param str job_depends_on: Comma separated list of existing job IDs
98
- the job will depend on.
99
- :param str job_tags: Job tags.
100
- :param str job_scheduled_start_time: Time when the job is scheduled to
101
- start.
102
- :param str job_priority: Priority of the job.
103
- :param bool job_dry_run: Flag indicating that the job will be executed
104
- in dry-run mode. In this mode, OpenCGA will validate that all
105
- parameters and prerequisites are correctly set for successful
106
- execution, but the job will not actually run.
107
- :param str project: Project [organization@]project where project can
108
- be either the ID or the alias.
109
- :param str study: Study [[organization@]project:]study where study and
110
- project can be either the ID or UUID.
111
- :param dict data: Variant annotation index params.
112
- """
113
-
114
- return self._post(category='operation', resource='index', subcategory='variant/annotation', data=data, **options)
115
-
116
- def save_variant_annotation(self, data=None, **options):
117
- """
118
- Save a copy of the current variant annotation at the database.
119
- PATH: /{apiVersion}/operation/variant/annotation/save
120
-
121
- :param str job_id: Job ID. It must be a unique string within the
122
- study. An ID will be autogenerated automatically if not provided.
123
- :param str job_description: Job description.
124
- :param str job_depends_on: Comma separated list of existing job IDs
125
- the job will depend on.
126
- :param str job_tags: Job tags.
127
- :param str job_scheduled_start_time: Time when the job is scheduled to
128
- start.
129
- :param str job_priority: Priority of the job.
130
- :param bool job_dry_run: Flag indicating that the job will be executed
131
- in dry-run mode. In this mode, OpenCGA will validate that all
132
- parameters and prerequisites are correctly set for successful
133
- execution, but the job will not actually run.
134
- :param str project: Project [organization@]project where project can
135
- be either the ID or the alias.
136
- :param dict data: Variant annotation save params.
137
- """
138
-
139
- return self._post(category='operation', resource='save', subcategory='variant/annotation', data=data, **options)
140
-
141
- def configure_variant(self, data=None, **options):
142
- """
143
- Update Variant Storage Engine configuration. Can be updated at Project
144
- or Study level.
145
- PATH: /{apiVersion}/operation/variant/configure
146
-
147
- :param str project: Project [organization@]project where project can
148
- be either the ID or the alias.
149
- :param str study: Study [[organization@]project:]study where study and
150
- project can be either the ID or UUID.
151
- :param dict data: Configuration params to update.
152
- """
153
-
154
- return self._post(category='operation', resource='configure', subcategory='variant', data=data, **options)
155
-
156
- def delete_variant(self, data=None, **options):
157
- """
158
- Remove variant files from the variant storage.
159
- PATH: /{apiVersion}/operation/variant/delete
160
-
161
- :param str job_id: Job ID. It must be a unique string within the
162
- study. An ID will be autogenerated automatically if not provided.
163
- :param str job_description: Job description.
164
- :param str job_depends_on: Comma separated list of existing job IDs
165
- the job will depend on.
166
- :param str job_tags: Job tags.
167
- :param str job_scheduled_start_time: Time when the job is scheduled to
168
- start.
169
- :param str job_priority: Priority of the job.
170
- :param bool job_dry_run: Flag indicating that the job will be executed
171
- in dry-run mode. In this mode, OpenCGA will validate that all
172
- parameters and prerequisites are correctly set for successful
173
- execution, but the job will not actually run.
174
- :param str study: Study [[organization@]project:]study where study and
175
- project can be either the ID or UUID.
176
- :param dict data: Variant delete file params.
177
- """
178
-
179
- return self._post(category='operation', resource='delete', subcategory='variant', data=data, **options)
180
-
181
- def aggregate_variant_family(self, data=None, **options):
182
- """
183
- Find variants where not all the samples are present, and fill the
184
- empty values.
185
- PATH: /{apiVersion}/operation/variant/family/aggregate
186
-
187
- :param str job_id: Job ID. It must be a unique string within the
188
- study. An ID will be autogenerated automatically if not provided.
189
- :param str job_description: Job description.
190
- :param str job_depends_on: Comma separated list of existing job IDs
191
- the job will depend on.
192
- :param str job_tags: Job tags.
193
- :param str job_scheduled_start_time: Time when the job is scheduled to
194
- start.
195
- :param str job_priority: Priority of the job.
196
- :param bool job_dry_run: Flag indicating that the job will be executed
197
- in dry-run mode. In this mode, OpenCGA will validate that all
198
- parameters and prerequisites are correctly set for successful
199
- execution, but the job will not actually run.
200
- :param str study: Study [[organization@]project:]study where study and
201
- project can be either the ID or UUID.
202
- :param dict data: Variant aggregate family params.
203
- """
204
-
205
- return self._post(category='operation', resource='aggregate', subcategory='variant/family', data=data, **options)
206
-
207
- def index_variant_family(self, data=None, **options):
208
- """
209
- DEPRECATED: integrated in index (DEPRECATED Build the family index).
210
- PATH: /{apiVersion}/operation/variant/family/index
211
-
212
- :param str job_id: Job ID. It must be a unique string within the
213
- study. An ID will be autogenerated automatically if not provided.
214
- :param str job_description: Job description.
215
- :param str job_depends_on: Comma separated list of existing job IDs
216
- the job will depend on.
217
- :param str job_tags: Job tags.
218
- :param str job_scheduled_start_time: Time when the job is scheduled to
219
- start.
220
- :param str job_priority: Priority of the job.
221
- :param bool job_dry_run: Flag indicating that the job will be executed
222
- in dry-run mode. In this mode, OpenCGA will validate that all
223
- parameters and prerequisites are correctly set for successful
224
- execution, but the job will not actually run.
225
- :param str study: Study [[organization@]project:]study where study and
226
- project can be either the ID or UUID.
227
- :param dict data: Variant family index params.
228
- """
229
-
230
- return self._post(category='operation', resource='index', subcategory='variant/family', data=data, **options)
231
-
232
- def index_variant(self, data=None, **options):
233
- """
234
- Index variant files into the variant storage.
235
- PATH: /{apiVersion}/operation/variant/index
236
-
237
- :param str job_id: Job ID. It must be a unique string within the
238
- study. An ID will be autogenerated automatically if not provided.
239
- :param str job_description: Job description.
240
- :param str job_depends_on: Comma separated list of existing job IDs
241
- the job will depend on.
242
- :param str job_tags: Job tags.
243
- :param str job_scheduled_start_time: Time when the job is scheduled to
244
- start.
245
- :param str job_priority: Priority of the job.
246
- :param bool job_dry_run: Flag indicating that the job will be executed
247
- in dry-run mode. In this mode, OpenCGA will validate that all
248
- parameters and prerequisites are correctly set for successful
249
- execution, but the job will not actually run.
250
- :param str study: Study [[organization@]project:]study where study and
251
- project can be either the ID or UUID.
252
- :param dict data: Variant index params.
253
- """
254
-
255
- return self._post(category='operation', resource='index', subcategory='variant', data=data, **options)
256
-
257
- def launcher_variant_index(self, data=None, **options):
258
- """
259
- Detect non-indexed VCF files in the study, and submit a job for
260
- indexing them.
261
- PATH: /{apiVersion}/operation/variant/index/launcher
262
-
263
- :param str job_id: Job ID. It must be a unique string within the
264
- study. An ID will be autogenerated automatically if not provided.
265
- :param str job_description: Job description.
266
- :param str job_depends_on: Comma separated list of existing job IDs
267
- the job will depend on.
268
- :param str job_tags: Job tags.
269
- :param str job_scheduled_start_time: Time when the job is scheduled to
270
- start.
271
- :param str job_priority: Priority of the job.
272
- :param bool job_dry_run: Flag indicating that the job will be executed
273
- in dry-run mode. In this mode, OpenCGA will validate that all
274
- parameters and prerequisites are correctly set for successful
275
- execution, but the job will not actually run.
276
- :param str study: Study [[organization@]project:]study where study and
277
- project can be either the ID or UUID.
278
- :param dict data: .
279
- """
280
-
281
- return self._post(category='operation', resource='launcher', subcategory='variant/index', data=data, **options)
282
-
283
- def run_variant_julie(self, data=None, **options):
284
- """
285
- Transform VariantStats into PopulationFrequency values and updates the
286
- VariantAnnotation.
287
- PATH: /{apiVersion}/operation/variant/julie/run
288
-
289
- :param dict data: Julie tool params. Specify list of cohorts from
290
- multiple studies with {study}:{cohort}. (REQUIRED)
291
- :param str job_id: Job ID. It must be a unique string within the
292
- study. An ID will be autogenerated automatically if not provided.
293
- :param str job_description: Job description.
294
- :param str job_depends_on: Comma separated list of existing job IDs
295
- the job will depend on.
296
- :param str job_tags: Job tags.
297
- :param str job_scheduled_start_time: Time when the job is scheduled to
298
- start.
299
- :param str job_priority: Priority of the job.
300
- :param bool job_dry_run: Flag indicating that the job will be executed
301
- in dry-run mode. In this mode, OpenCGA will validate that all
302
- parameters and prerequisites are correctly set for successful
303
- execution, but the job will not actually run.
304
- :param str project: project.
305
- """
306
-
307
- return self._post(category='operation', resource='run', subcategory='variant/julie', data=data, **options)
308
-
309
- def repair_variant_metadata(self, data=None, **options):
310
- """
311
- Execute some repairs on Variant Storage Metadata. Advanced users only.
312
- PATH: /{apiVersion}/operation/variant/metadata/repair
313
-
314
- :param str job_id: Job ID. It must be a unique string within the
315
- study. An ID will be autogenerated automatically if not provided.
316
- :param str job_description: Job description.
317
- :param str job_depends_on: Comma separated list of existing job IDs
318
- the job will depend on.
319
- :param str job_tags: Job tags.
320
- :param str job_scheduled_start_time: Time when the job is scheduled to
321
- start.
322
- :param str job_priority: Priority of the job.
323
- :param bool job_dry_run: Flag indicating that the job will be executed
324
- in dry-run mode. In this mode, OpenCGA will validate that all
325
- parameters and prerequisites are correctly set for successful
326
- execution, but the job will not actually run.
327
- :param dict data: Variant storage metadata repair params.
328
- """
329
-
330
- return self._post(category='operation', resource='repair', subcategory='variant/metadata', data=data, **options)
331
-
332
- def synchronize_variant_metadata(self, data=None, **options):
333
- """
334
- Synchronize catalog with variant storage metadata.
335
- PATH: /{apiVersion}/operation/variant/metadata/synchronize
336
-
337
- :param str job_id: Job ID. It must be a unique string within the
338
- study. An ID will be autogenerated automatically if not provided.
339
- :param str job_description: Job description.
340
- :param str job_depends_on: Comma separated list of existing job IDs
341
- the job will depend on.
342
- :param str job_tags: Job tags.
343
- :param str job_scheduled_start_time: Time when the job is scheduled to
344
- start.
345
- :param str job_priority: Priority of the job.
346
- :param bool job_dry_run: Flag indicating that the job will be executed
347
- in dry-run mode. In this mode, OpenCGA will validate that all
348
- parameters and prerequisites are correctly set for successful
349
- execution, but the job will not actually run.
350
- :param str study: Study [[organization@]project:]study where study and
351
- project can be either the ID or UUID.
352
- :param dict data: Variant storage metadata synchronize params.
353
- """
354
-
355
- return self._post(category='operation', resource='synchronize', subcategory='variant/metadata', data=data, **options)
356
-
357
- def prune_variant(self, data=None, **options):
358
- """
359
- Prune orphan variants from studies in a project.
360
- PATH: /{apiVersion}/operation/variant/prune
361
-
362
- :param str job_id: Job ID. It must be a unique string within the
363
- study. An ID will be autogenerated automatically if not provided.
364
- :param str job_description: Job description.
365
- :param str job_depends_on: Comma separated list of existing job IDs
366
- the job will depend on.
367
- :param str job_tags: Job tags.
368
- :param str job_scheduled_start_time: Time when the job is scheduled to
369
- start.
370
- :param str job_priority: Priority of the job.
371
- :param bool job_dry_run: Flag indicating that the job will be executed
372
- in dry-run mode. In this mode, OpenCGA will validate that all
373
- parameters and prerequisites are correctly set for successful
374
- execution, but the job will not actually run.
375
- :param dict data: Variant prune params. Use dry-run to just generate a
376
- report with the orphan variants.
377
- """
378
-
379
- return self._post(category='operation', resource='prune', subcategory='variant', data=data, **options)
380
-
381
- def delete_variant_sample(self, data=None, **options):
382
- """
383
- Remove variant samples from the variant storage.
384
- PATH: /{apiVersion}/operation/variant/sample/delete
385
-
386
- :param str job_id: Job ID. It must be a unique string within the
387
- study. An ID will be autogenerated automatically if not provided.
388
- :param str job_description: Job description.
389
- :param str job_depends_on: Comma separated list of existing job IDs
390
- the job will depend on.
391
- :param str job_tags: Job tags.
392
- :param str job_scheduled_start_time: Time when the job is scheduled to
393
- start.
394
- :param str job_priority: Priority of the job.
395
- :param bool job_dry_run: Flag indicating that the job will be executed
396
- in dry-run mode. In this mode, OpenCGA will validate that all
397
- parameters and prerequisites are correctly set for successful
398
- execution, but the job will not actually run.
399
- :param str study: Study [[organization@]project:]study where study and
400
- project can be either the ID or UUID.
401
- :param dict data: Variant delete sample params.
402
- """
403
-
404
- return self._post(category='operation', resource='delete', subcategory='variant/sample', data=data, **options)
405
-
406
- def index_variant_sample(self, data=None, **options):
407
- """
408
- DEPRECATED You should use the new sample index method instead.
409
- PATH: /{apiVersion}/operation/variant/sample/index
410
-
411
- :param str job_id: Job ID. It must be a unique string within the
412
- study. An ID will be autogenerated automatically if not provided.
413
- :param str job_description: Job description.
414
- :param str job_depends_on: Comma separated list of existing job IDs
415
- the job will depend on.
416
- :param str job_tags: Job tags.
417
- :param str job_scheduled_start_time: Time when the job is scheduled to
418
- start.
419
- :param str job_priority: Priority of the job.
420
- :param bool job_dry_run: Flag indicating that the job will be executed
421
- in dry-run mode. In this mode, OpenCGA will validate that all
422
- parameters and prerequisites are correctly set for successful
423
- execution, but the job will not actually run.
424
- :param str study: Study [[organization@]project:]study where study and
425
- project can be either the ID or UUID.
426
- :param dict data: Variant sample index params.
427
- """
428
-
429
- return self._post(category='operation', resource='index', subcategory='variant/sample', data=data, **options)
430
-
431
- def variant_sample_index_configure(self, data=None, **options):
432
- """
433
- DEPRECATED You should use the new sample index configure method.
434
- PATH: /{apiVersion}/operation/variant/sample/index/configure
435
-
436
- :param str study: Study [[organization@]project:]study where study and
437
- project can be either the ID or UUID.
438
- :param bool skip_rebuild: Skip sample index re-build.
439
- :param dict data: New SampleIndexConfiguration.
440
- """
441
-
442
- return self._post(category='operation', resource='configure', subcategory='variant/sample/index', data=data, **options)
443
-
444
- def delete_variant_score(self, **options):
445
- """
446
- Remove a variant score in the database.
447
- PATH: /{apiVersion}/operation/variant/score/delete
448
-
449
- :param str job_id: Job ID. It must be a unique string within the
450
- study. An ID will be autogenerated automatically if not provided.
451
- :param str job_description: Job description.
452
- :param str job_depends_on: Comma separated list of existing job IDs
453
- the job will depend on.
454
- :param str job_tags: Job tags.
455
- :param str job_scheduled_start_time: Time when the job is scheduled to
456
- start.
457
- :param str job_priority: Priority of the job.
458
- :param bool job_dry_run: Flag indicating that the job will be executed
459
- in dry-run mode. In this mode, OpenCGA will validate that all
460
- parameters and prerequisites are correctly set for successful
461
- execution, but the job will not actually run.
462
- :param str study: Study [[organization@]project:]study where study and
463
- project can be either the ID or UUID.
464
- :param str name: Unique name of the score within the study.
465
- :param bool resume: Resume a previously failed remove.
466
- :param bool force: Force remove of partially indexed scores.
467
- """
468
-
469
- return self._delete(category='operation', resource='delete', subcategory='variant/score', **options)
470
-
471
- def index_variant_score(self, data=None, **options):
472
- """
473
- Index a variant score in the database.
474
- PATH: /{apiVersion}/operation/variant/score/index
475
-
476
- :param str job_id: Job ID. It must be a unique string within the
477
- study. An ID will be autogenerated automatically if not provided.
478
- :param str job_description: Job description.
479
- :param str job_depends_on: Comma separated list of existing job IDs
480
- the job will depend on.
481
- :param str job_tags: Job tags.
482
- :param str job_scheduled_start_time: Time when the job is scheduled to
483
- start.
484
- :param str job_priority: Priority of the job.
485
- :param bool job_dry_run: Flag indicating that the job will be executed
486
- in dry-run mode. In this mode, OpenCGA will validate that all
487
- parameters and prerequisites are correctly set for successful
488
- execution, but the job will not actually run.
489
- :param str study: Study [[organization@]project:]study where study and
490
- project can be either the ID or UUID.
491
- :param dict data: Variant score index params. scoreName: Unique name
492
- of the score within the study. cohort1: Cohort used to compute the
493
- score. Use the cohort 'ALL' if all samples from the study where
494
- used to compute the score. cohort2: Second cohort used to compute
495
- the score, typically to compare against the first cohort. If only
496
- one cohort was used to compute the score, leave empty.
497
- inputColumns: Indicate which columns to load from the input file.
498
- Provide the column position (starting in 0) for the column with the
499
- score with 'SCORE=n'. Optionally, the PValue column with
500
- 'PVALUE=n'. The, to indicate the variant associated with the score,
501
- provide either the columns ['CHROM', 'POS', 'REF', 'ALT'], or the
502
- column 'VAR' containing a variant representation with format
503
- 'chr:start:ref:alt'. e.g.
504
- 'CHROM=0,POS=1,REF=3,ALT=4,SCORE=5,PVALUE=6' or
505
- 'VAR=0,SCORE=1,PVALUE=2'. resume: Resume a previously failed
506
- indexation.
507
- """
508
-
509
- return self._post(category='operation', resource='index', subcategory='variant/score', data=data, **options)
510
-
511
- def variant_secondary_annotation_index(self, data=None, **options):
512
- """
513
- Creates a secondary index using a search engine. If samples are
514
- provided, sample data will be added to the secondary index. (New!).
515
- PATH: /{apiVersion}/operation/variant/secondary/annotation/index
516
-
517
- :param str job_id: Job ID. It must be a unique string within the
518
- study. An ID will be autogenerated automatically if not provided.
519
- :param str job_description: Job description.
520
- :param str job_depends_on: Comma separated list of existing job IDs
521
- the job will depend on.
522
- :param str job_tags: Job tags.
523
- :param str job_scheduled_start_time: Time when the job is scheduled to
524
- start.
525
- :param str job_priority: Priority of the job.
526
- :param bool job_dry_run: Flag indicating that the job will be executed
527
- in dry-run mode. In this mode, OpenCGA will validate that all
528
- parameters and prerequisites are correctly set for successful
529
- execution, but the job will not actually run.
530
- :param str project: Project [organization@]project where project can
531
- be either the ID or the alias.
532
- :param str study: Study [[organization@]project:]study where study and
533
- project can be either the ID or UUID.
534
- :param dict data: Variant secondary annotation index params.
535
- """
536
-
537
- return self._post(category='operation', resource='index', subcategory='variant/secondary/annotation', data=data, **options)
538
-
539
- def variant_secondary_sample_index(self, data=None, **options):
540
- """
541
- Build and annotate the sample index. (New!) .
542
- PATH: /{apiVersion}/operation/variant/secondary/sample/index
543
-
544
- :param str job_id: Job ID. It must be a unique string within the
545
- study. An ID will be autogenerated automatically if not provided.
546
- :param str job_description: Job description.
547
- :param str job_depends_on: Comma separated list of existing job IDs
548
- the job will depend on.
549
- :param str job_tags: Job tags.
550
- :param str job_scheduled_start_time: Time when the job is scheduled to
551
- start.
552
- :param str job_priority: Priority of the job.
553
- :param bool job_dry_run: Flag indicating that the job will be executed
554
- in dry-run mode. In this mode, OpenCGA will validate that all
555
- parameters and prerequisites are correctly set for successful
556
- execution, but the job will not actually run.
557
- :param str study: Study [[organization@]project:]study where study and
558
- project can be either the ID or UUID.
559
- :param dict data: Variant sample index params.
560
- """
561
-
562
- return self._post(category='operation', resource='index', subcategory='variant/secondary/sample', data=data, **options)
563
-
564
- def configure_variant_secondary_sample_index(self, data=None, **options):
565
- """
566
- Update SampleIndex configuration (New!).
567
- PATH: /{apiVersion}/operation/variant/secondary/sample/index/configure
568
-
569
- :param str study: Study [[organization@]project:]study where study and
570
- project can be either the ID or UUID.
571
- :param bool skip_rebuild: Skip sample index re-build.
572
- :param dict data: New SampleIndexConfiguration.
573
- """
574
-
575
- return self._post(category='operation', resource='configure', subcategory='variant/secondary/sample/index', data=data, **options)
576
-
577
- def secondary_index_variant(self, data=None, **options):
578
- """
579
- DEPRECATED you should use the new annotation index method instead.
580
- PATH: /{apiVersion}/operation/variant/secondaryIndex
581
-
582
- :param str job_id: Job ID. It must be a unique string within the
583
- study. An ID will be autogenerated automatically if not provided.
584
- :param str job_description: Job description.
585
- :param str job_depends_on: Comma separated list of existing job IDs
586
- the job will depend on.
587
- :param str job_tags: Job tags.
588
- :param str job_scheduled_start_time: Time when the job is scheduled to
589
- start.
590
- :param str job_priority: Priority of the job.
591
- :param bool job_dry_run: Flag indicating that the job will be executed
592
- in dry-run mode. In this mode, OpenCGA will validate that all
593
- parameters and prerequisites are correctly set for successful
594
- execution, but the job will not actually run.
595
- :param str project: Project [organization@]project where project can
596
- be either the ID or the alias.
597
- :param str study: Study [[organization@]project:]study where study and
598
- project can be either the ID or UUID.
599
- :param dict data: Variant secondary annotation index params.
600
- """
601
-
602
- return self._post(category='operation', resource='secondaryIndex', subcategory='variant', data=data, **options)
603
-
604
- def delete_variant_secondary_index(self, **options):
605
- """
606
- Remove a secondary index from the search engine for a specific set of
607
- samples.
608
- PATH: /{apiVersion}/operation/variant/secondaryIndex/delete
609
-
610
- :param str job_id: Job ID. It must be a unique string within the
611
- study. An ID will be autogenerated automatically if not provided.
612
- :param str job_description: Job description.
613
- :param str job_depends_on: Comma separated list of existing job IDs
614
- the job will depend on.
615
- :param str job_tags: Job tags.
616
- :param str job_scheduled_start_time: Time when the job is scheduled to
617
- start.
618
- :param str job_priority: Priority of the job.
619
- :param bool job_dry_run: Flag indicating that the job will be executed
620
- in dry-run mode. In this mode, OpenCGA will validate that all
621
- parameters and prerequisites are correctly set for successful
622
- execution, but the job will not actually run.
623
- :param str study: Study [[organization@]project:]study where study and
624
- project can be either the ID or UUID.
625
- :param str samples: Samples to remove. Needs to provide all the
626
- samples in the secondary index.
627
- """
628
-
629
- return self._delete(category='operation', resource='delete', subcategory='variant/secondaryIndex', **options)
630
-
631
- def setup_variant(self, data=None, **options):
632
- """
633
- Execute Variant Setup to allow using the variant engine. This setup is
634
- necessary before starting any variant operation.
635
- PATH: /{apiVersion}/operation/variant/setup
636
-
637
- :param str study: Study [[organization@]project:]study where study and
638
- project can be either the ID or UUID.
639
- :param dict data: Variant setup params.
640
- """
641
-
642
- return self._post(category='operation', resource='setup', subcategory='variant', data=data, **options)
643
-
644
- def delete_variant_stats(self, data=None, **options):
645
- """
646
- Deletes the VariantStats of a cohort/s from the database.
647
- PATH: /{apiVersion}/operation/variant/stats/delete
648
-
649
- :param dict data: Variant stats delete params. (REQUIRED)
650
- :param str study: Study [[organization@]project:]study where study and
651
- project can be either the ID or UUID.
652
- :param str job_id: Job ID. It must be a unique string within the
653
- study. An ID will be autogenerated automatically if not provided.
654
- :param str job_description: Job description.
655
- :param str job_depends_on: Comma separated list of existing job IDs
656
- the job will depend on.
657
- :param str job_tags: Job tags.
658
- :param str job_scheduled_start_time: Time when the job is scheduled to
659
- start.
660
- :param str job_priority: Priority of the job.
661
- :param bool job_dry_run: Flag indicating that the job will be executed
662
- in dry-run mode. In this mode, OpenCGA will validate that all
663
- parameters and prerequisites are correctly set for successful
664
- execution, but the job will not actually run.
665
- """
666
-
667
- return self._post(category='operation', resource='delete', subcategory='variant/stats', data=data, **options)
668
-
669
- def index_variant_stats(self, data=None, **options):
670
- """
671
- Compute variant stats for any cohort and any set of variants and index
672
- the result in the variant storage database.
673
- PATH: /{apiVersion}/operation/variant/stats/index
674
-
675
- :param dict data: Variant stats params. (REQUIRED)
676
- :param str study: Study [[organization@]project:]study where study and
677
- project can be either the ID or UUID.
678
- :param str job_id: Job ID. It must be a unique string within the
679
- study. An ID will be autogenerated automatically if not provided.
680
- :param str job_description: Job description.
681
- :param str job_depends_on: Comma separated list of existing job IDs
682
- the job will depend on.
683
- :param str job_tags: Job tags.
684
- :param str job_scheduled_start_time: Time when the job is scheduled to
685
- start.
686
- :param str job_priority: Priority of the job.
687
- :param bool job_dry_run: Flag indicating that the job will be executed
688
- in dry-run mode. In this mode, OpenCGA will validate that all
689
- parameters and prerequisites are correctly set for successful
690
- execution, but the job will not actually run.
691
- """
692
-
693
- return self._post(category='operation', resource='index', subcategory='variant/stats', data=data, **options)
694
-
695
- def delete_variant_study(self, data=None, **options):
696
- """
697
- Remove whole study from the variant storage.
698
- PATH: /{apiVersion}/operation/variant/study/delete
699
-
700
- :param str job_id: Job ID. It must be a unique string within the
701
- study. An ID will be autogenerated automatically if not provided.
702
- :param str job_description: Job description.
703
- :param str job_depends_on: Comma separated list of existing job IDs
704
- the job will depend on.
705
- :param str job_tags: Job tags.
706
- :param str job_scheduled_start_time: Time when the job is scheduled to
707
- start.
708
- :param str job_priority: Priority of the job.
709
- :param bool job_dry_run: Flag indicating that the job will be executed
710
- in dry-run mode. In this mode, OpenCGA will validate that all
711
- parameters and prerequisites are correctly set for successful
712
- execution, but the job will not actually run.
713
- :param str study: Study [[organization@]project:]study where study and
714
- project can be either the ID or UUID.
715
- :param dict data: Variant delete study params.
716
- """
717
-
718
- return self._post(category='operation', resource='delete', subcategory='variant/study', data=data, **options)
719
-