pyxetabase 4.0.0.dev56__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.

Potentially problematic release.


This version of pyxetabase might be problematic. Click here for more details.

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