pyxetabase 4.0.0.dev40__tar.gz → 4.0.0.dev69__tar.gz

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-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/PKG-INFO +1 -1
  2. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/admin_client.py +10 -0
  3. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/clinical_analysis_client.py +17 -74
  4. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/cvdb_client.py +31 -5
  5. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/disease_panel_client.py +6 -13
  6. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/file_client.py +12 -0
  7. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase.egg-info/PKG-INFO +1 -1
  8. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/setup.py +1 -1
  9. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/LICENSE +0 -0
  10. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/README.rst +0 -0
  11. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/__init__.py +0 -0
  12. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/commons.py +0 -0
  13. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/exceptions.py +0 -0
  14. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/opencga_client.py +0 -0
  15. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/opencga_config.py +0 -0
  16. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/__init__.py +0 -0
  17. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/_parent_rest_clients.py +0 -0
  18. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/alignment_client.py +0 -0
  19. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/cohort_client.py +0 -0
  20. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/family_client.py +0 -0
  21. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/federation_client.py +0 -0
  22. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/ga4gh_client.py +0 -0
  23. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/individual_client.py +0 -0
  24. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/job_client.py +0 -0
  25. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/meta_client.py +0 -0
  26. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/organization_client.py +0 -0
  27. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/project_client.py +0 -0
  28. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/sample_client.py +0 -0
  29. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/study_client.py +0 -0
  30. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/user_client.py +0 -0
  31. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/variant_client.py +0 -0
  32. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/variant_operation_client.py +0 -0
  33. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_clients/workflow_client.py +0 -0
  34. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/rest_response.py +0 -0
  35. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase/retry.py +0 -0
  36. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase.egg-info/SOURCES.txt +0 -0
  37. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase.egg-info/dependency_links.txt +0 -0
  38. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase.egg-info/requires.txt +0 -0
  39. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/pyxetabase.egg-info/top_level.txt +0 -0
  40. {pyxetabase-4.0.0.dev40 → pyxetabase-4.0.0.dev69}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pyxetabase
3
- Version: 4.0.0.dev40
3
+ Version: 4.0.0.dev69
4
4
  Summary: A REST client for OpenCGA enterprise REST web services
5
5
  Author: Daniel Perez-Gil
6
6
  Author-email: daniel.perez@zettagenomics.com
@@ -54,6 +54,16 @@ class Admin(_ParentRestClient):
54
54
 
55
55
  return self._post(category='admin', resource='install', subcategory='catalog', data=data, **options)
56
56
 
57
+ def update_catalog_workspace(self, data=None, **options):
58
+ """
59
+ Update the OpenCGA Catalog workspace.
60
+ PATH: /{apiVersion}/admin/catalog/workspace/update
61
+
62
+ :param dict data: JSON containing the workspace parameters. (REQUIRED)
63
+ """
64
+
65
+ return self._post(category='admin', resource='update', subcategory='catalog/workspace', data=data, **options)
66
+
57
67
  def list_organizations(self, **options):
58
68
  """
59
69
  List current Organizations.
@@ -350,32 +350,6 @@ class ClinicalAnalysis(_ParentRestClient):
350
350
 
351
351
  return self._get(category='analysis', resource='info', subcategory='clinical/interpretation', second_query_id=interpretations, **options)
352
352
 
353
- def run_interpreter_cancer_tiering(self, data=None, **options):
354
- """
355
- Run cancer tiering interpretation analysis.
356
- PATH: /{apiVersion}/analysis/clinical/interpreter/cancerTiering/run
357
-
358
- :param dict data: Cancer tiering interpretation analysis params.
359
- (REQUIRED)
360
- :param str study: Study [[organization@]project:]study where study and
361
- project can be either the ID or UUID.
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
- """
376
-
377
- return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/cancerTiering', data=data, **options)
378
-
379
353
  def run_interpreter_exomiser(self, data=None, **options):
380
354
  """
381
355
  Run exomiser interpretation analysis.
@@ -401,62 +375,31 @@ class ClinicalAnalysis(_ParentRestClient):
401
375
 
402
376
  return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/exomiser', data=data, **options)
403
377
 
404
- def run_interpreter_team(self, data=None, **options):
405
- """
406
- Run TEAM interpretation analysis.
407
- PATH: /{apiVersion}/analysis/clinical/interpreter/team/run
408
-
409
- :param dict data: TEAM interpretation analysis params. (REQUIRED)
410
- :param str study: Study [[organization@]project:]study where study and
411
- project can be either the ID or UUID.
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
- """
426
-
427
- return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/team', data=data, **options)
428
-
429
- def run_interpreter_tiering(self, data=None, **options):
378
+ def rd_interpreter(self, **options):
430
379
  """
431
- Run tiering interpretation analysis.
432
- PATH: /{apiVersion}/analysis/clinical/interpreter/tiering/run
380
+ Rare disease interpretation analysis.
381
+ PATH: /{apiVersion}/analysis/clinical/interpreter/rd
433
382
 
434
- :param dict data: Tiering interpretation analysis params. (REQUIRED)
383
+ :param str clinical_analysis_id: Clinical analysis ID.
384
+ :param str proband_id: Proband ID.
385
+ :param str family_id: Family ID.
386
+ :param str panel_ids: List of panel IDs (separated by commas).
387
+ :param str disorder_id: Disorder ID.
388
+ :param str config_file: RD interpretation configuration file
389
+ (otherwise the default one will be used).
435
390
  :param str study: Study [[organization@]project:]study where study and
436
391
  project can be either the ID or UUID.
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
392
  """
451
393
 
452
- return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/tiering', data=data, **options)
394
+ return self._get(category='analysis', resource='rd', subcategory='clinical/interpreter', **options)
453
395
 
454
- def run_interpreter_zetta(self, data=None, **options):
396
+ def run_interpreter_rd(self, data=None, **options):
455
397
  """
456
- Run Zetta interpretation analysis.
457
- PATH: /{apiVersion}/analysis/clinical/interpreter/zetta/run
398
+ Run interpretation analysis for rare diseases.
399
+ PATH: /{apiVersion}/analysis/clinical/interpreter/rd/run
458
400
 
459
- :param dict data: Zetta interpretation analysis params. (REQUIRED)
401
+ :param dict data: Parameters to execute the rare disease
402
+ interpretation analysis. (REQUIRED)
460
403
  :param str study: Study [[organization@]project:]study where study and
461
404
  project can be either the ID or UUID.
462
405
  :param str job_id: Job ID. It must be a unique string within the
@@ -474,7 +417,7 @@ class ClinicalAnalysis(_ParentRestClient):
474
417
  execution, but the job will not actually run.
475
418
  """
476
419
 
477
- return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/zetta', data=data, **options)
420
+ return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/rd', data=data, **options)
478
421
 
479
422
  def load(self, data=None, **options):
480
423
  """
@@ -593,6 +593,33 @@ class CVDB(_ParentRestClient):
593
593
 
594
594
  return self._get(category='analysis', resource='query', subcategory='cvdb/analysis', **options)
595
595
 
596
+ def run_delete(self, data=None, **options):
597
+ """
598
+ Delete clinical analyses indexed in CVDB for a given study or a list
599
+ of clinical analysis IDs.
600
+ PATH: /{apiVersion}/analysis/cvdb/delete/run
601
+
602
+ :param dict data: Parameters: Delete clinical analyses indexed in CVDB
603
+ for a given study or a list of clinical analysis IDs. (REQUIRED)
604
+ :param str study: Study [[organization@]project:]study where study and
605
+ project can be either the ID or UUID.
606
+ :param str job_id: Job ID. It must be a unique string within the
607
+ study. An ID will be autogenerated automatically if not provided.
608
+ :param str job_description: Job description.
609
+ :param str job_depends_on: Comma separated list of existing job IDs
610
+ the job will depend on.
611
+ :param str job_tags: Job tags.
612
+ :param str job_scheduled_start_time: Time when the job is scheduled to
613
+ start.
614
+ :param str job_priority: Priority of the job.
615
+ :param bool job_dry_run: Flag indicating that the job will be executed
616
+ in dry-run mode. In this mode, OpenCGA will validate that all
617
+ parameters and prerequisites are correctly set for successful
618
+ execution, but the job will not actually run.
619
+ """
620
+
621
+ return self._post(category='analysis', resource='run', subcategory='cvdb/delete', data=data, **options)
622
+
596
623
  def aggregate_evidence(self, **options):
597
624
  """
598
625
  Calculate and fetch clinical variant evidence aggregation stats.
@@ -1145,13 +1172,12 @@ class CVDB(_ParentRestClient):
1145
1172
 
1146
1173
  def run_index(self, data=None, **options):
1147
1174
  """
1148
- Index clinical analyses of a OpenCGA project, a study or a list of
1149
- clinical analyses into CVDB.
1175
+ Index clinical analyses of a study or a list of clinical analyses into
1176
+ CVDB.
1150
1177
  PATH: /{apiVersion}/analysis/cvdb/index/run
1151
1178
 
1152
- :param dict data: Parameters: Index clinical analyses of a OpenCGA
1153
- project, a study or a list of clinical analyses into CVDB.
1154
- (REQUIRED)
1179
+ :param dict data: Parameters: Index clinical analyses of a study or a
1180
+ list of clinical analyses into CVDB. (REQUIRED)
1155
1181
  :param str study: Study [[organization@]project:]study where study and
1156
1182
  project can be either the ID or UUID.
1157
1183
  :param str job_id: Job ID. It must be a unique string within the
@@ -190,21 +190,14 @@ class DiseasePanel(_ParentRestClient):
190
190
  Import panels.
191
191
  PATH: /{apiVersion}/panels/import
192
192
 
193
+ :param str include: Fields included in the response, whole JSON path
194
+ must be provided.
195
+ :param str exclude: Fields excluded in the response, whole JSON path
196
+ must be provided.
193
197
  :param str study: Study [[organization@]project:]study where study and
194
198
  project can be either the ID or UUID.
195
- :param str job_id: Job ID. It must be a unique string within the
196
- study. An ID will be autogenerated automatically if not provided.
197
- :param str job_depends_on: Comma separated list of existing job IDs
198
- the job will depend on.
199
- :param str job_description: Job description.
200
- :param str job_tags: Job tags.
201
- :param str job_scheduled_start_time: Time when the job is scheduled to
202
- start.
203
- :param str job_priority: Priority of the job.
204
- :param bool job_dry_run: Flag indicating that the job will be executed
205
- in dry-run mode. In this mode, OpenCGA will validate that all
206
- parameters and prerequisites are correctly set for successful
207
- execution, but the job will not actually run.
199
+ :param bool include_result: Flag indicating to include the created or
200
+ updated document result in the response.
208
201
  :param dict data: Panel parameters.
209
202
  """
210
203
 
@@ -436,6 +436,18 @@ class File(_ParentRestClient):
436
436
 
437
437
  return self._post(category='files', resource='upload', **options)
438
438
 
439
+ def update_uri(self, data=None, **options):
440
+ """
441
+ Update URIs of files that have been manually moved in disk.
442
+ PATH: /{apiVersion}/files/uri/update
443
+
444
+ :param dict data: Parameters to modify. (REQUIRED)
445
+ :param str study: Study [[organization@]project:]study where study and
446
+ project can be either the ID or UUID.
447
+ """
448
+
449
+ return self._post(category='files', resource='update', subcategory='uri', data=data, **options)
450
+
439
451
  def acl(self, files, **options):
440
452
  """
441
453
  Return the acl defined for the file or folder. If member is provided,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pyxetabase
3
- Version: 4.0.0.dev40
3
+ Version: 4.0.0.dev69
4
4
  Summary: A REST client for OpenCGA enterprise REST web services
5
5
  Author: Daniel Perez-Gil
6
6
  Author-email: daniel.perez@zettagenomics.com
@@ -14,7 +14,7 @@ with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
14
14
 
15
15
  setup(
16
16
  name='pyxetabase',
17
- version='4.0.0.dev40',
17
+ version='4.0.0.dev69',
18
18
  description='A REST client for OpenCGA enterprise REST web services',
19
19
  long_description=long_description,
20
20
  long_description_content_type='text/x-rst',