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