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,1279 +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 ClinicalAnalysis(_ParentRestClient):
14
- """
15
- This class contains methods for the 'Analysis - Clinical' webservices
16
- PATH: /{apiVersion}/analysis/clinical
17
- """
18
-
19
- def __init__(self, configuration, token=None, login_handler=None, *args, **kwargs):
20
- super(ClinicalAnalysis, self).__init__(configuration, token, login_handler, *args, **kwargs)
21
-
22
- def update_acl(self, members, action, data=None, **options):
23
- """
24
- Update the set of permissions granted for the member.
25
- PATH: /{apiVersion}/analysis/clinical/acl/{members}/update
26
-
27
- :param dict data: JSON containing the parameters to add ACLs.
28
- (REQUIRED)
29
- :param str action: Action to be performed [ADD, SET, REMOVE or RESET].
30
- Allowed values: ['SET ADD REMOVE RESET'] (REQUIRED)
31
- :param str members: Comma separated list of user or group IDs.
32
- (REQUIRED)
33
- :param str study: Study [[organization@]project:]study where study and
34
- project can be either the ID or UUID.
35
- :param bool propagate: Propagate permissions to related families,
36
- individuals, samples and files.
37
- """
38
-
39
- options['action'] = action
40
- return self._post(category='analysis', resource='update', subcategory='clinical/acl', second_query_id=members, data=data, **options)
41
-
42
- def aggregation_stats(self, **options):
43
- """
44
- Fetch catalog clinical analysis aggregation stats.
45
- PATH: /{apiVersion}/analysis/clinical/aggregationStats
46
-
47
- :param str study: Study [[organization@]project:]study where study and
48
- project can be either the ID or UUID.
49
- :param str id: Comma separated list of Clinical Analysis IDs up to a
50
- maximum of 100. Also admits basic regular expressions using the
51
- operator '~', i.e. '~{perl-regex}' e.g. '~value' for case
52
- sensitive, '~/value/i' for case insensitive search.
53
- :param str uuid: Comma separated list of Clinical Analysis UUIDs up to
54
- a maximum of 100.
55
- :param str type: Clinical Analysis type.
56
- :param str disorder: Clinical Analysis disorder. Also admits basic
57
- regular expressions using the operator '~', i.e. '~{perl-regex}'
58
- e.g. '~value' for case sensitive, '~/value/i' for case insensitive
59
- search.
60
- :param str files: Clinical Analysis files.
61
- :param str sample: Sample associated to the proband or any member of a
62
- family.
63
- :param str individual: Proband or any member of a family.
64
- :param str proband: Clinical Analysis proband.
65
- :param str proband_samples: Clinical Analysis proband samples.
66
- :param str family: Clinical Analysis family.
67
- :param str family_members: Clinical Analysis family members.
68
- :param str family_member_samples: Clinical Analysis family members
69
- samples.
70
- :param str panels: Clinical Analysis panels.
71
- :param bool locked: Locked Clinical Analyses.
72
- :param str analyst_id: Clinical Analysis analyst id.
73
- :param str priority: Clinical Analysis priority.
74
- :param str flags: Clinical Analysis flags.
75
- :param str creation_date: Clinical Analysis Creation date. Format:
76
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
77
- :param str modification_date: Clinical Analysis Modification date.
78
- Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
79
- :param str due_date: Clinical Analysis due date. Format:
80
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
81
- :param str quality_control_summary: Clinical Analysis quality control
82
- summary.
83
- :param str release: Release when it was created.
84
- :param int snapshot: Snapshot value (Latest version of the entry in
85
- the specified release).
86
- :param str status: Filter by status.
87
- :param str internal_status: Filter by internal status.
88
- :param str annotation: Annotation filters. Example:
89
- age>30;gender=FEMALE. For more information, please visit
90
- http://docs.opencb.org/display/opencga/AnnotationSets+1.4.0.
91
- :param bool deleted: Boolean to retrieve deleted entries.
92
- :param str field: Field to apply aggregation statistics to (or a list
93
- of fields separated by semicolons), e.g.:
94
- studies;type;numSamples[0..10]:1;format:sum(size).
95
- """
96
-
97
- return self._get(category='analysis', resource='aggregationStats', subcategory='clinical', **options)
98
-
99
- def load_annotation_sets(self, variable_set_id, path, data=None, **options):
100
- """
101
- Load annotation sets from a TSV file.
102
- PATH: /{apiVersion}/analysis/clinical/annotationSets/load
103
-
104
- :param str path: Path where the TSV file is located in OpenCGA or
105
- where it should be located. (REQUIRED)
106
- :param str variable_set_id: Variable set ID or name. (REQUIRED)
107
- :param str study: Study [[organization@]project:]study where study and
108
- project can be either the ID or UUID.
109
- :param bool parents: Flag indicating whether to create parent
110
- directories if they don't exist (only when TSV file was not
111
- previously associated).
112
- :param str annotation_set_id: Annotation set id. If not provided,
113
- variableSetId will be used.
114
- :param dict data: JSON containing the 'content' of the TSV file if
115
- this has not yet been registered into OpenCGA.
116
- """
117
-
118
- options['variableSetId'] = variable_set_id
119
- options['path'] = path
120
- return self._post(category='analysis', resource='load', subcategory='clinical/annotationSets', data=data, **options)
121
-
122
- def update_clinical_configuration(self, data=None, **options):
123
- """
124
- Update Clinical Analysis configuration.
125
- PATH: /{apiVersion}/analysis/clinical/clinical/configuration/update
126
-
127
- :param str study: Study [[organization@]project:]study where study and
128
- project can be either the ID or UUID.
129
- :param dict data: Configuration params to update.
130
- """
131
-
132
- return self._post(category='analysis', resource='update', subcategory='clinical/clinical/configuration', data=data, **options)
133
-
134
- def create(self, data=None, **options):
135
- """
136
- Create a new clinical analysis.
137
- PATH: /{apiVersion}/analysis/clinical/create
138
-
139
- :param dict data: JSON containing clinical analysis information.
140
- (REQUIRED)
141
- :param str include: Fields included in the response, whole JSON path
142
- must be provided.
143
- :param str exclude: Fields excluded in the response, whole JSON path
144
- must be provided.
145
- :param str study: Study [[organization@]project:]study where study and
146
- project can be either the ID or UUID.
147
- :param bool skip_create_default_interpretation: Flag to skip creating
148
- and initialise an empty default primary interpretation (Id will be
149
- '{clinicalAnalysisId}.1'). This flag is only considered if no
150
- Interpretation object is passed.
151
- :param bool include_result: Flag indicating to include the created or
152
- updated document result in the response.
153
- """
154
-
155
- return self._post(category='analysis', resource='create', subcategory='clinical', data=data, **options)
156
-
157
- def distinct(self, field, **options):
158
- """
159
- Clinical Analysis distinct method.
160
- PATH: /{apiVersion}/analysis/clinical/distinct
161
-
162
- :param str field: Comma separated list of fields for which to obtain
163
- the distinct values. (REQUIRED)
164
- :param str study: Study [[organization@]project:]study where study and
165
- project can be either the ID or UUID.
166
- :param str id: Comma separated list of Clinical Analysis IDs up to a
167
- maximum of 100. Also admits basic regular expressions using the
168
- operator '~', i.e. '~{perl-regex}' e.g. '~value' for case
169
- sensitive, '~/value/i' for case insensitive search.
170
- :param str uuid: Comma separated list of Clinical Analysis UUIDs up to
171
- a maximum of 100.
172
- :param str type: Clinical Analysis type.
173
- :param str disorder: Clinical Analysis disorder. Also admits basic
174
- regular expressions using the operator '~', i.e. '~{perl-regex}'
175
- e.g. '~value' for case sensitive, '~/value/i' for case insensitive
176
- search.
177
- :param str files: Clinical Analysis files.
178
- :param str sample: Sample associated to the proband or any member of a
179
- family.
180
- :param str individual: Proband or any member of a family.
181
- :param str proband: Clinical Analysis proband.
182
- :param str proband_samples: Clinical Analysis proband samples.
183
- :param str family: Clinical Analysis family.
184
- :param str family_members: Clinical Analysis family members.
185
- :param str family_member_samples: Clinical Analysis family members
186
- samples.
187
- :param str panels: Clinical Analysis panels.
188
- :param bool locked: Locked Clinical Analyses.
189
- :param str analyst_id: Clinical Analysis analyst id.
190
- :param str priority: Clinical Analysis priority.
191
- :param str flags: Clinical Analysis flags.
192
- :param str creation_date: Clinical Analysis Creation date. Format:
193
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
194
- :param str modification_date: Clinical Analysis Modification date.
195
- Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
196
- :param str due_date: Clinical Analysis due date. Format:
197
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
198
- :param str quality_control_summary: Clinical Analysis quality control
199
- summary.
200
- :param str release: Release when it was created.
201
- :param int snapshot: Snapshot value (Latest version of the entry in
202
- the specified release).
203
- :param str status: Filter by status.
204
- :param str internal_status: Filter by internal status.
205
- :param str annotation: Annotation filters. Example:
206
- age>30;gender=FEMALE. For more information, please visit
207
- http://docs.opencb.org/display/opencga/AnnotationSets+1.4.0.
208
- :param bool deleted: Boolean to retrieve deleted entries.
209
- """
210
-
211
- options['field'] = field
212
- return self._get(category='analysis', resource='distinct', subcategory='clinical', **options)
213
-
214
- def aggregation_stats_interpretation(self, **options):
215
- """
216
- Fetch catalog interpretation aggregation stats.
217
- PATH: /{apiVersion}/analysis/clinical/interpretation/aggregationStats
218
-
219
- :param str study: Study [[organization@]project:]study where study and
220
- project can be either the ID or UUID.
221
- :param str id: Comma separated list of Interpretation IDs up to a
222
- maximum of 100. Also admits basic regular expressions using the
223
- operator '~', i.e. '~{perl-regex}' e.g. '~value' for case
224
- sensitive, '~/value/i' for case insensitive search.
225
- :param str uuid: Comma separated list of Interpretation UUIDs up to a
226
- maximum of 100.
227
- :param str name: Comma separated list of Interpretation names up to a
228
- maximum of 100.
229
- :param str clinical_analysis_id: Clinical Analysis id.
230
- :param str analyst_id: Analyst ID.
231
- :param str method_name: Interpretation method name. Also admits basic
232
- regular expressions using the operator '~', i.e. '~{perl-regex}'
233
- e.g. '~value' for case sensitive, '~/value/i' for case insensitive
234
- search.
235
- :param str panels: Interpretation panels.
236
- :param str primary_findings: Interpretation primary findings.
237
- :param str secondary_findings: Interpretation secondary findings.
238
- :param str creation_date: Interpretation Creation date. Format:
239
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
240
- :param str modification_date: Interpretation Modification date.
241
- Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
242
- :param str status: Filter by status.
243
- :param str internal_status: Filter by internal status.
244
- :param str release: Release when it was created.
245
- :param str field: Field to apply aggregation statistics to (or a list
246
- of fields separated by semicolons), e.g.:
247
- studies;type;numSamples[0..10]:1;format:sum(size).
248
- """
249
-
250
- return self._get(category='analysis', resource='aggregationStats', subcategory='clinical/interpretation', **options)
251
-
252
- def distinct_interpretation(self, field, **options):
253
- """
254
- Interpretation distinct method.
255
- PATH: /{apiVersion}/analysis/clinical/interpretation/distinct
256
-
257
- :param str field: Comma separated list of fields for which to obtain
258
- the distinct values. (REQUIRED)
259
- :param str study: Study [[organization@]project:]study where study and
260
- project can be either the ID or UUID.
261
- :param str id: Comma separated list of Interpretation IDs up to a
262
- maximum of 100. Also admits basic regular expressions using the
263
- operator '~', i.e. '~{perl-regex}' e.g. '~value' for case
264
- sensitive, '~/value/i' for case insensitive search.
265
- :param str uuid: Comma separated list of Interpretation UUIDs up to a
266
- maximum of 100.
267
- :param str name: Comma separated list of Interpretation names up to a
268
- maximum of 100.
269
- :param str clinical_analysis_id: Clinical Analysis id.
270
- :param str analyst_id: Analyst ID.
271
- :param str method_name: Interpretation method name. Also admits basic
272
- regular expressions using the operator '~', i.e. '~{perl-regex}'
273
- e.g. '~value' for case sensitive, '~/value/i' for case insensitive
274
- search.
275
- :param str panels: Interpretation panels.
276
- :param str primary_findings: Interpretation primary findings.
277
- :param str secondary_findings: Interpretation secondary findings.
278
- :param str creation_date: Interpretation Creation date. Format:
279
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
280
- :param str modification_date: Interpretation Modification date.
281
- Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
282
- :param str status: Filter by status.
283
- :param str internal_status: Filter by internal status.
284
- :param str release: Release when it was created.
285
- """
286
-
287
- options['field'] = field
288
- return self._get(category='analysis', resource='distinct', subcategory='clinical/interpretation', **options)
289
-
290
- def search_interpretation(self, **options):
291
- """
292
- Search clinical interpretations.
293
- PATH: /{apiVersion}/analysis/clinical/interpretation/search
294
-
295
- :param str include: Fields included in the response, whole JSON path
296
- must be provided.
297
- :param str exclude: Fields excluded in the response, whole JSON path
298
- must be provided.
299
- :param int limit: Number of results to be returned.
300
- :param int skip: Number of results to skip.
301
- :param bool sort: Sort the results.
302
- :param str study: Study [[organization@]project:]study where study and
303
- project can be either the ID or UUID.
304
- :param str id: Comma separated list of Interpretation IDs up to a
305
- maximum of 100. Also admits basic regular expressions using the
306
- operator '~', i.e. '~{perl-regex}' e.g. '~value' for case
307
- sensitive, '~/value/i' for case insensitive search.
308
- :param str uuid: Comma separated list of Interpretation UUIDs up to a
309
- maximum of 100.
310
- :param str name: Comma separated list of Interpretation names up to a
311
- maximum of 100.
312
- :param str clinical_analysis_id: Clinical Analysis id.
313
- :param str analyst_id: Analyst ID.
314
- :param str method_name: Interpretation method name. Also admits basic
315
- regular expressions using the operator '~', i.e. '~{perl-regex}'
316
- e.g. '~value' for case sensitive, '~/value/i' for case insensitive
317
- search.
318
- :param str panels: Interpretation panels.
319
- :param str primary_findings: Interpretation primary findings.
320
- :param str secondary_findings: Interpretation secondary findings.
321
- :param str creation_date: Interpretation Creation date. Format:
322
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
323
- :param str modification_date: Interpretation Modification date.
324
- Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
325
- :param str status: Filter by status.
326
- :param str internal_status: Filter by internal status.
327
- :param str release: Release when it was created.
328
- """
329
-
330
- return self._get(category='analysis', resource='search', subcategory='clinical/interpretation', **options)
331
-
332
- def info_interpretation(self, interpretations, **options):
333
- """
334
- Clinical interpretation information.
335
- PATH: /{apiVersion}/analysis/clinical/interpretation/{interpretations}/info
336
-
337
- :param str interpretations: Comma separated list of clinical
338
- interpretation IDs up to a maximum of 100. (REQUIRED)
339
- :param str include: Fields included in the response, whole JSON path
340
- must be provided.
341
- :param str exclude: Fields excluded in the response, whole JSON path
342
- must be provided.
343
- :param str study: Study [[organization@]project:]study where study and
344
- project can be either the ID or UUID.
345
- :param str version: Comma separated list of interpretation versions.
346
- 'all' to get all the interpretation versions. Not supported if
347
- multiple interpretation ids are provided.
348
- :param bool deleted: Boolean to retrieve deleted entries.
349
- """
350
-
351
- return self._get(category='analysis', resource='info', subcategory='clinical/interpretation', second_query_id=interpretations, **options)
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
- def run_interpreter_exomiser(self, data=None, **options):
380
- """
381
- Run exomiser interpretation analysis.
382
- PATH: /{apiVersion}/analysis/clinical/interpreter/exomiser/run
383
-
384
- :param dict data: Exomiser interpretation analysis params. (REQUIRED)
385
- :param str study: Study [[organization@]project:]study where study and
386
- project can be either the ID or UUID.
387
- :param str job_id: Job ID. It must be a unique string within the
388
- study. An ID will be autogenerated automatically if not provided.
389
- :param str job_description: Job description.
390
- :param str job_depends_on: Comma separated list of existing job IDs
391
- the job will depend on.
392
- :param str job_tags: Job tags.
393
- :param str job_scheduled_start_time: Time when the job is scheduled to
394
- start.
395
- :param str job_priority: Priority of the job.
396
- :param bool job_dry_run: Flag indicating that the job will be executed
397
- in dry-run mode. In this mode, OpenCGA will validate that all
398
- parameters and prerequisites are correctly set for successful
399
- execution, but the job will not actually run.
400
- """
401
-
402
- return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/exomiser', data=data, **options)
403
-
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):
430
- """
431
- Run tiering interpretation analysis.
432
- PATH: /{apiVersion}/analysis/clinical/interpreter/tiering/run
433
-
434
- :param dict data: Tiering interpretation analysis params. (REQUIRED)
435
- :param str study: Study [[organization@]project:]study where study and
436
- 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
- """
451
-
452
- return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/tiering', data=data, **options)
453
-
454
- def run_interpreter_zetta(self, data=None, **options):
455
- """
456
- Run Zetta interpretation analysis.
457
- PATH: /{apiVersion}/analysis/clinical/interpreter/zetta/run
458
-
459
- :param dict data: Zetta interpretation analysis params. (REQUIRED)
460
- :param str study: Study [[organization@]project:]study where study and
461
- project can be either the ID or UUID.
462
- :param str job_id: Job ID. It must be a unique string within the
463
- study. An ID will be autogenerated automatically if not provided.
464
- :param str job_description: Job description.
465
- :param str job_depends_on: Comma separated list of existing job IDs
466
- the job will depend on.
467
- :param str job_tags: Job tags.
468
- :param str job_scheduled_start_time: Time when the job is scheduled to
469
- start.
470
- :param str job_priority: Priority of the job.
471
- :param bool job_dry_run: Flag indicating that the job will be executed
472
- in dry-run mode. In this mode, OpenCGA will validate that all
473
- parameters and prerequisites are correctly set for successful
474
- execution, but the job will not actually run.
475
- """
476
-
477
- return self._post(category='analysis', resource='run', subcategory='clinical/interpreter/zetta', data=data, **options)
478
-
479
- def load(self, data=None, **options):
480
- """
481
- Load clinical analyses from a file.
482
- PATH: /{apiVersion}/analysis/clinical/load
483
-
484
- :param dict data: Parameters to load clinical analysis in OpenCGA
485
- catalog from a file. (REQUIRED)
486
- :param str study: Study [[organization@]project:]study where study and
487
- project can be either the ID or UUID.
488
- :param str job_id: Job ID. It must be a unique string within the
489
- study. An ID will be autogenerated automatically if not provided.
490
- :param str job_description: Job description.
491
- :param str job_depends_on: Comma separated list of existing job IDs
492
- the job will depend on.
493
- :param str job_tags: Job tags.
494
- :param str job_scheduled_start_time: Time when the job is scheduled to
495
- start.
496
- :param str job_priority: Priority of the job.
497
- :param bool job_dry_run: Flag indicating that the job will be executed
498
- in dry-run mode. In this mode, OpenCGA will validate that all
499
- parameters and prerequisites are correctly set for successful
500
- execution, but the job will not actually run.
501
- """
502
-
503
- return self._post(category='analysis', resource='load', subcategory='clinical', data=data, **options)
504
-
505
- def aggregation_stats_rga(self, field, **options):
506
- """
507
- RGA aggregation stats.
508
- PATH: /{apiVersion}/analysis/clinical/rga/aggregationStats
509
-
510
- :param str field: List of fields separated by semicolons, e.g.:
511
- clinicalSignificances;type. For nested fields use >>, e.g.:
512
- type>>clinicalSignificances;knockoutType. (REQUIRED)
513
- :param int limit: Number of results to be returned.
514
- :param int skip: Number of results to skip.
515
- :param str sample_id: Filter by sample id.
516
- :param str individual_id: Filter by individual id.
517
- :param str sex: Filter by sex.
518
- :param str phenotypes: Filter by phenotypes.
519
- :param str disorders: Filter by disorders.
520
- :param str num_parents: Filter by the number of parents registered.
521
- :param str gene_id: Filter by gene id.
522
- :param str gene_name: Filter by gene name.
523
- :param str chromosome: Filter by chromosome.
524
- :param str start: Filter by start position.
525
- :param str end: Filter by end position.
526
- :param str transcript_id: Filter by transcript id.
527
- :param str variants: Filter by variant id.
528
- :param str db_snps: Filter by DB_SNP id.
529
- :param str knockout_type: Filter by knockout type.
530
- :param str filter: Filter by filter (PASS, NOT_PASS).
531
- :param str type: Filter by variant type.
532
- :param str clinical_significance: Filter by clinical significance.
533
- :param str population_frequency: Filter by population frequency.
534
- :param str consequence_type: Filter by consequence type.
535
- :param str study: Study [[organization@]project:]study where study and
536
- project can be either the ID or UUID.
537
- """
538
-
539
- options['field'] = field
540
- return self._get(category='analysis', resource='aggregationStats', subcategory='clinical/rga', **options)
541
-
542
- def query_rga_gene(self, **options):
543
- """
544
- Query gene RGA.
545
- PATH: /{apiVersion}/analysis/clinical/rga/gene/query
546
-
547
- :param str include: Fields included in the response, whole JSON path
548
- must be provided.
549
- :param str exclude: Fields excluded in the response, whole JSON path
550
- must be provided.
551
- :param int limit: Number of results to be returned.
552
- :param int skip: Number of results to skip.
553
- :param bool count: Get the total number of results matching the query.
554
- Deactivated by default.
555
- :param str include_individual: Include only the comma separated list
556
- of individuals to the response.
557
- :param int skip_individual: Number of individuals to skip.
558
- :param int limit_individual: Limit number of individuals returned
559
- (default: 1000).
560
- :param str sample_id: Filter by sample id.
561
- :param str individual_id: Filter by individual id.
562
- :param str sex: Filter by sex.
563
- :param str phenotypes: Filter by phenotypes.
564
- :param str disorders: Filter by disorders.
565
- :param str num_parents: Filter by the number of parents registered.
566
- :param str gene_id: Filter by gene id.
567
- :param str gene_name: Filter by gene name.
568
- :param str chromosome: Filter by chromosome.
569
- :param str start: Filter by start position.
570
- :param str end: Filter by end position.
571
- :param str transcript_id: Filter by transcript id.
572
- :param str variants: Filter by variant id.
573
- :param str db_snps: Filter by DB_SNP id.
574
- :param str knockout_type: Filter by knockout type.
575
- :param str filter: Filter by filter (PASS, NOT_PASS).
576
- :param str type: Filter by variant type.
577
- :param str clinical_significance: Filter by clinical significance.
578
- :param str population_frequency: Filter by population frequency.
579
- :param str consequence_type: Filter by consequence type.
580
- :param str study: Study [[organization@]project:]study where study and
581
- project can be either the ID or UUID.
582
- """
583
-
584
- return self._get(category='analysis', resource='query', subcategory='clinical/rga/gene', **options)
585
-
586
- def summary_rga_gene(self, **options):
587
- """
588
- RGA gene summary stats.
589
- PATH: /{apiVersion}/analysis/clinical/rga/gene/summary
590
-
591
- :param int limit: Number of results to be returned.
592
- :param int skip: Number of results to skip.
593
- :param bool count: Get the total number of results matching the query.
594
- Deactivated by default.
595
- :param str sample_id: Filter by sample id.
596
- :param str individual_id: Filter by individual id.
597
- :param str sex: Filter by sex.
598
- :param str phenotypes: Filter by phenotypes.
599
- :param str disorders: Filter by disorders.
600
- :param str num_parents: Filter by the number of parents registered.
601
- :param str gene_id: Filter by gene id.
602
- :param str gene_name: Filter by gene name.
603
- :param str chromosome: Filter by chromosome.
604
- :param str start: Filter by start position.
605
- :param str end: Filter by end position.
606
- :param str transcript_id: Filter by transcript id.
607
- :param str variants: Filter by variant id.
608
- :param str db_snps: Filter by DB_SNP id.
609
- :param str knockout_type: Filter by knockout type.
610
- :param str filter: Filter by filter (PASS, NOT_PASS).
611
- :param str type: Filter by variant type.
612
- :param str clinical_significance: Filter by clinical significance.
613
- :param str population_frequency: Filter by population frequency.
614
- :param str consequence_type: Filter by consequence type.
615
- :param str study: Study [[organization@]project:]study where study and
616
- project can be either the ID or UUID.
617
- """
618
-
619
- return self._get(category='analysis', resource='summary', subcategory='clinical/rga/gene', **options)
620
-
621
- def run_rga_index(self, data=None, **options):
622
- """
623
- Generate Recessive Gene Analysis secondary index.
624
- PATH: /{apiVersion}/analysis/clinical/rga/index/run
625
-
626
- :param dict data: Recessive Gene Analysis index params. (REQUIRED)
627
- :param str study: Study [[organization@]project:]study where study and
628
- project can be either the ID or UUID.
629
- :param str job_id: Job ID. It must be a unique string within the
630
- study. An ID will be autogenerated automatically if not provided.
631
- :param str job_description: Job description.
632
- :param str job_depends_on: Comma separated list of existing job IDs
633
- the job will depend on.
634
- :param str job_tags: Job tags.
635
- :param str job_scheduled_start_time: Time when the job is scheduled to
636
- start.
637
- :param str job_priority: Priority of the job.
638
- :param bool job_dry_run: Flag indicating that the job will be executed
639
- in dry-run mode. In this mode, OpenCGA will validate that all
640
- parameters and prerequisites are correctly set for successful
641
- execution, but the job will not actually run.
642
- :param bool auxiliar_index: Index auxiliar collection to improve
643
- performance assuming RGA is completely indexed.
644
- """
645
-
646
- return self._post(category='analysis', resource='run', subcategory='clinical/rga/index', data=data, **options)
647
-
648
- def query_rga_individual(self, **options):
649
- """
650
- Query individual RGA.
651
- PATH: /{apiVersion}/analysis/clinical/rga/individual/query
652
-
653
- :param str include: Fields included in the response, whole JSON path
654
- must be provided.
655
- :param str exclude: Fields excluded in the response, whole JSON path
656
- must be provided.
657
- :param int limit: Number of results to be returned.
658
- :param int skip: Number of results to skip.
659
- :param bool count: Get the total number of results matching the query.
660
- Deactivated by default.
661
- :param str sample_id: Filter by sample id.
662
- :param str individual_id: Filter by individual id.
663
- :param str sex: Filter by sex.
664
- :param str phenotypes: Filter by phenotypes.
665
- :param str disorders: Filter by disorders.
666
- :param str num_parents: Filter by the number of parents registered.
667
- :param str gene_id: Filter by gene id.
668
- :param str gene_name: Filter by gene name.
669
- :param str chromosome: Filter by chromosome.
670
- :param str start: Filter by start position.
671
- :param str end: Filter by end position.
672
- :param str transcript_id: Filter by transcript id.
673
- :param str variants: Filter by variant id.
674
- :param str db_snps: Filter by DB_SNP id.
675
- :param str knockout_type: Filter by knockout type.
676
- :param str filter: Filter by filter (PASS, NOT_PASS).
677
- :param str type: Filter by variant type.
678
- :param str clinical_significance: Filter by clinical significance.
679
- :param str population_frequency: Filter by population frequency.
680
- :param str consequence_type: Filter by consequence type.
681
- :param str study: Study [[organization@]project:]study where study and
682
- project can be either the ID or UUID.
683
- """
684
-
685
- return self._get(category='analysis', resource='query', subcategory='clinical/rga/individual', **options)
686
-
687
- def summary_rga_individual(self, **options):
688
- """
689
- RGA individual summary stats.
690
- PATH: /{apiVersion}/analysis/clinical/rga/individual/summary
691
-
692
- :param int limit: Number of results to be returned.
693
- :param int skip: Number of results to skip.
694
- :param bool count: Get the total number of results matching the query.
695
- Deactivated by default.
696
- :param str sample_id: Filter by sample id.
697
- :param str individual_id: Filter by individual id.
698
- :param str sex: Filter by sex.
699
- :param str phenotypes: Filter by phenotypes.
700
- :param str disorders: Filter by disorders.
701
- :param str num_parents: Filter by the number of parents registered.
702
- :param str gene_id: Filter by gene id.
703
- :param str gene_name: Filter by gene name.
704
- :param str chromosome: Filter by chromosome.
705
- :param str start: Filter by start position.
706
- :param str end: Filter by end position.
707
- :param str transcript_id: Filter by transcript id.
708
- :param str variants: Filter by variant id.
709
- :param str db_snps: Filter by DB_SNP id.
710
- :param str knockout_type: Filter by knockout type.
711
- :param str filter: Filter by filter (PASS, NOT_PASS).
712
- :param str type: Filter by variant type.
713
- :param str clinical_significance: Filter by clinical significance.
714
- :param str population_frequency: Filter by population frequency.
715
- :param str consequence_type: Filter by consequence type.
716
- :param str study: Study [[organization@]project:]study where study and
717
- project can be either the ID or UUID.
718
- """
719
-
720
- return self._get(category='analysis', resource='summary', subcategory='clinical/rga/individual', **options)
721
-
722
- def query_rga_variant(self, **options):
723
- """
724
- Query variant RGA.
725
- PATH: /{apiVersion}/analysis/clinical/rga/variant/query
726
-
727
- :param str include: Fields included in the response, whole JSON path
728
- must be provided.
729
- :param str exclude: Fields excluded in the response, whole JSON path
730
- must be provided.
731
- :param int limit: Number of results to be returned.
732
- :param int skip: Number of results to skip.
733
- :param bool count: Get the total number of results matching the query.
734
- Deactivated by default.
735
- :param str include_individual: Include only the comma separated list
736
- of individuals to the response.
737
- :param int skip_individual: Number of individuals to skip.
738
- :param int limit_individual: Limit number of individuals returned
739
- (default: 1000).
740
- :param str sample_id: Filter by sample id.
741
- :param str individual_id: Filter by individual id.
742
- :param str sex: Filter by sex.
743
- :param str phenotypes: Filter by phenotypes.
744
- :param str disorders: Filter by disorders.
745
- :param str num_parents: Filter by the number of parents registered.
746
- :param str gene_id: Filter by gene id.
747
- :param str gene_name: Filter by gene name.
748
- :param str chromosome: Filter by chromosome.
749
- :param str start: Filter by start position.
750
- :param str end: Filter by end position.
751
- :param str transcript_id: Filter by transcript id.
752
- :param str variants: Filter by variant id.
753
- :param str db_snps: Filter by DB_SNP id.
754
- :param str knockout_type: Filter by knockout type.
755
- :param str filter: Filter by filter (PASS, NOT_PASS).
756
- :param str type: Filter by variant type.
757
- :param str clinical_significance: Filter by clinical significance.
758
- :param str population_frequency: Filter by population frequency.
759
- :param str consequence_type: Filter by consequence type.
760
- :param str study: Study [[organization@]project:]study where study and
761
- project can be either the ID or UUID.
762
- """
763
-
764
- return self._get(category='analysis', resource='query', subcategory='clinical/rga/variant', **options)
765
-
766
- def summary_rga_variant(self, **options):
767
- """
768
- RGA variant summary stats.
769
- PATH: /{apiVersion}/analysis/clinical/rga/variant/summary
770
-
771
- :param int limit: Number of results to be returned.
772
- :param int skip: Number of results to skip.
773
- :param bool count: Get the total number of results matching the query.
774
- Deactivated by default.
775
- :param str sample_id: Filter by sample id.
776
- :param str individual_id: Filter by individual id.
777
- :param str sex: Filter by sex.
778
- :param str phenotypes: Filter by phenotypes.
779
- :param str disorders: Filter by disorders.
780
- :param str num_parents: Filter by the number of parents registered.
781
- :param str gene_id: Filter by gene id.
782
- :param str gene_name: Filter by gene name.
783
- :param str chromosome: Filter by chromosome.
784
- :param str start: Filter by start position.
785
- :param str end: Filter by end position.
786
- :param str transcript_id: Filter by transcript id.
787
- :param str variants: Filter by variant id.
788
- :param str db_snps: Filter by DB_SNP id.
789
- :param str knockout_type: Filter by knockout type.
790
- :param str filter: Filter by filter (PASS, NOT_PASS).
791
- :param str type: Filter by variant type.
792
- :param str clinical_significance: Filter by clinical significance.
793
- :param str population_frequency: Filter by population frequency.
794
- :param str consequence_type: Filter by consequence type.
795
- :param str study: Study [[organization@]project:]study where study and
796
- project can be either the ID or UUID.
797
- """
798
-
799
- return self._get(category='analysis', resource='summary', subcategory='clinical/rga/variant', **options)
800
-
801
- def search(self, **options):
802
- """
803
- Clinical analysis search.
804
- PATH: /{apiVersion}/analysis/clinical/search
805
-
806
- :param str include: Fields included in the response, whole JSON path
807
- must be provided.
808
- :param str exclude: Fields excluded in the response, whole JSON path
809
- must be provided.
810
- :param int limit: Number of results to be returned.
811
- :param int skip: Number of results to skip.
812
- :param bool count: Get the total number of results matching the query.
813
- Deactivated by default.
814
- :param bool flatten_annotations: Flatten the annotations?.
815
- :param str study: Study [[organization@]project:]study where study and
816
- project can be either the ID or UUID.
817
- :param str id: Comma separated list of Clinical Analysis IDs up to a
818
- maximum of 100. Also admits basic regular expressions using the
819
- operator '~', i.e. '~{perl-regex}' e.g. '~value' for case
820
- sensitive, '~/value/i' for case insensitive search.
821
- :param str uuid: Comma separated list of Clinical Analysis UUIDs up to
822
- a maximum of 100.
823
- :param str type: Clinical Analysis type.
824
- :param str disorder: Clinical Analysis disorder. Also admits basic
825
- regular expressions using the operator '~', i.e. '~{perl-regex}'
826
- e.g. '~value' for case sensitive, '~/value/i' for case insensitive
827
- search.
828
- :param str files: Clinical Analysis files.
829
- :param str sample: Sample associated to the proband or any member of a
830
- family.
831
- :param str individual: Proband or any member of a family.
832
- :param str proband: Clinical Analysis proband.
833
- :param str proband_samples: Clinical Analysis proband samples.
834
- :param str family: Clinical Analysis family.
835
- :param str family_members: Clinical Analysis family members.
836
- :param str family_member_samples: Clinical Analysis family members
837
- samples.
838
- :param str panels: Clinical Analysis panels.
839
- :param bool locked: Locked Clinical Analyses.
840
- :param str analyst_id: Clinical Analysis analyst id.
841
- :param str priority: Clinical Analysis priority.
842
- :param str flags: Clinical Analysis flags.
843
- :param str creation_date: Clinical Analysis Creation date. Format:
844
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
845
- :param str modification_date: Clinical Analysis Modification date.
846
- Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
847
- :param str due_date: Clinical Analysis due date. Format:
848
- yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
849
- :param str quality_control_summary: Clinical Analysis quality control
850
- summary.
851
- :param str release: Release when it was created.
852
- :param int snapshot: Snapshot value (Latest version of the entry in
853
- the specified release).
854
- :param str status: Filter by status.
855
- :param str internal_status: Filter by internal status.
856
- :param str annotation: Annotation filters. Example:
857
- age>30;gender=FEMALE. For more information, please visit
858
- http://docs.opencb.org/display/opencga/AnnotationSets+1.4.0.
859
- :param bool deleted: Boolean to retrieve deleted entries.
860
- """
861
-
862
- return self._get(category='analysis', resource='search', subcategory='clinical', **options)
863
-
864
- def query_variant(self, **options):
865
- """
866
- Fetch clinical variants.
867
- PATH: /{apiVersion}/analysis/clinical/variant/query
868
-
869
- :param str include: Fields included in the response, whole JSON path
870
- must be provided.
871
- :param str exclude: Fields excluded in the response, whole JSON path
872
- must be provided.
873
- :param int limit: Number of results to be returned.
874
- :param int skip: Number of results to skip.
875
- :param bool count: Get the total number of results matching the query.
876
- Deactivated by default.
877
- :param bool approximate_count: Get an approximate count, instead of an
878
- exact total count. Reduces execution time.
879
- :param int approximate_count_sampling_size: Sampling size to get the
880
- approximate count. Larger values increase accuracy but also
881
- increase execution time.
882
- :param str saved_filter: Use a saved filter at User level.
883
- :param str include_interpretation: Interpretation ID to include the
884
- fields related to this interpretation.
885
- :param str id: List of variant IDs in the format chrom:start:ref:alt,
886
- e.g. 19:7177679:C:T.
887
- :param str region: List of regions, these can be just a single
888
- chromosome name or regions in the format chr:start-end, e.g.:
889
- 2,3:100000-200000.
890
- :param str type: List of types, accepted values are SNV, MNV, INDEL,
891
- SV, COPY_NUMBER, COPY_NUMBER_LOSS, COPY_NUMBER_GAIN, INSERTION,
892
- DELETION, DUPLICATION, TANDEM_DUPLICATION, BREAKEND, e.g.
893
- SNV,INDEL.
894
- :param str study: Filter variants from the given studies, these can be
895
- either the numeric ID or the alias with the format
896
- organization@project:study.
897
- :param str file: Filter variants from the files specified. This will
898
- set includeFile parameter when not provided.
899
- :param str filter: Specify the FILTER for any of the files. If 'file'
900
- filter is provided, will match the file and the filter. e.g.:
901
- PASS,LowGQX.
902
- :param str qual: Specify the QUAL for any of the files. If 'file'
903
- filter is provided, will match the file and the qual. e.g.: >123.4.
904
- :param str file_data: Filter by file data (i.e. FILTER, QUAL and INFO
905
- columns from VCF file). [{file}:]{key}{op}{value}[,;]* . If no file
906
- is specified, will use all files from 'file' filter. e.g. AN>200 or
907
- file_1.vcf:AN>200;file_2.vcf:AN<10 . Many fields can be combined.
908
- e.g. file_1.vcf:AN>200;DB=true;file_2.vcf:AN<10,FILTER=PASS,LowDP.
909
- :param str sample: Filter variants by sample genotype. This will
910
- automatically set 'includeSample' parameter when not provided. This
911
- filter accepts multiple 3 forms: 1) List of samples: Samples that
912
- contain the main variant. Accepts AND ';' and OR ',' operators.
913
- e.g. HG0097,HG0098 . 2) List of samples with genotypes:
914
- {sample}:{gt1},{gt2}. Accepts AND ';' and OR ',' operators. e.g.
915
- HG0097:0/0;HG0098:0/1,1/1 . Unphased genotypes (e.g. 0/1, 1/1) will
916
- also include phased genotypes (e.g. 0|1, 1|0, 1|1), but not vice
917
- versa. When filtering by multi-allelic genotypes, any secondary
918
- allele will match, regardless of its position e.g. 1/2 will match
919
- with genotypes 1/2, 1/3, 1/4, .... Genotype aliases accepted:
920
- HOM_REF, HOM_ALT, HET, HET_REF, HET_ALT, HET_MISS and MISS e.g.
921
- HG0097:HOM_REF;HG0098:HET_REF,HOM_ALT . 3) Sample with segregation
922
- mode: {sample}:{segregation}. Only one sample accepted.Accepted
923
- segregation modes: [ autosomalDominant, autosomalRecessive,
924
- XLinkedDominant, XLinkedRecessive, YLinked, mitochondrial, deNovo,
925
- deNovoStrict, mendelianError, compoundHeterozygous ]. Value is case
926
- insensitive. e.g. HG0097:DeNovo Sample must have parents defined
927
- and indexed. .
928
- :param str sample_data: Filter by any SampleData field from samples.
929
- [{sample}:]{key}{op}{value}[,;]* . If no sample is specified, will
930
- use all samples from 'sample' or 'genotype' filter. e.g. DP>200 or
931
- HG0097:DP>200,HG0098:DP<10 . Many FORMAT fields can be combined.
932
- e.g. HG0097:DP>200;GT=1/1,0/1,HG0098:DP<10.
933
- :param str sample_annotation: Selects some samples using metadata
934
- information from Catalog. e.g.
935
- age>20;phenotype=hpo:123,hpo:456;name=smith.
936
- :param str cohort: Select variants with calculated stats for the
937
- selected cohorts.
938
- :param str cohort_stats_ref: Reference Allele Frequency:
939
- [{study:}]{cohort}[<|>|<=|>=]{number}. e.g. ALL<=0.4.
940
- :param str cohort_stats_alt: Alternate Allele Frequency:
941
- [{study:}]{cohort}[<|>|<=|>=]{number}. e.g. ALL<=0.4.
942
- :param str cohort_stats_maf: Minor Allele Frequency:
943
- [{study:}]{cohort}[<|>|<=|>=]{number}. e.g. ALL<=0.4.
944
- :param str cohort_stats_mgf: Minor Genotype Frequency:
945
- [{study:}]{cohort}[<|>|<=|>=]{number}. e.g. ALL<=0.4.
946
- :param str cohort_stats_pass: Filter PASS frequency:
947
- [{study:}]{cohort}[<|>|<=|>=]{number}. e.g. ALL>0.8.
948
- :param str missing_alleles: Number of missing alleles:
949
- [{study:}]{cohort}[<|>|<=|>=]{number}.
950
- :param str missing_genotypes: Number of missing genotypes:
951
- [{study:}]{cohort}[<|>|<=|>=]{number}.
952
- :param str score: Filter by variant score:
953
- [{study:}]{score}[<|>|<=|>=]{number}.
954
- :param str family: Filter variants where any of the samples from the
955
- given family contains the variant (HET or HOM_ALT).
956
- :param str family_disorder: Specify the disorder to use for the family
957
- segregation.
958
- :param str family_segregation: Filter by segregation mode from a given
959
- family. Accepted values: [ autosomalDominant, autosomalRecessive,
960
- XLinkedDominant, XLinkedRecessive, YLinked, mitochondrial, deNovo,
961
- deNovoStrict, mendelianError, compoundHeterozygous ].
962
- :param str family_members: Sub set of the members of a given family.
963
- :param str family_proband: Specify the proband child to use for the
964
- family segregation.
965
- :param str gene: List of genes, most gene IDs are accepted (HGNC,
966
- Ensembl gene, ...). This is an alias to 'xref' parameter.
967
- :param str ct: List of SO consequence types, e.g.
968
- missense_variant,stop_lost or SO:0001583,SO:0001578. Accepts
969
- aliases 'loss_of_function' and 'protein_altering'.
970
- :param str xref: List of any external reference, these can be genes,
971
- proteins or variants. Accepted IDs include HGNC, Ensembl genes,
972
- dbSNP, ClinVar, HPO, Cosmic, HGVS ...
973
- :param str biotype: List of biotypes, e.g. protein_coding.
974
- :param str protein_substitution: Protein substitution scores include
975
- SIFT and PolyPhen. You can query using the score
976
- {protein_score}[<|>|<=|>=]{number} or the description
977
- {protein_score}[~=|=]{description} e.g. polyphen>0.1,sift=tolerant.
978
- :param str conservation: Filter by conservation score:
979
- {conservation_score}[<|>|<=|>=]{number} e.g.
980
- phastCons>0.5,phylop<0.1,gerp>0.1.
981
- :param str population_frequency_alt: Alternate Population Frequency:
982
- {study}:{population}[<|>|<=|>=]{number}. e.g. 1000G:ALL<0.01.
983
- :param str population_frequency_ref: Reference Population Frequency:
984
- {study}:{population}[<|>|<=|>=]{number}. e.g. 1000G:ALL<0.01.
985
- :param str population_frequency_maf: Population minor allele
986
- frequency: {study}:{population}[<|>|<=|>=]{number}. e.g.
987
- 1000G:ALL<0.01.
988
- :param str transcript_flag: List of transcript flags. e.g. canonical,
989
- CCDS, basic, LRG, MANE Select, MANE Plus Clinical, EGLH_HaemOnc,
990
- TSO500.
991
- :param str gene_trait_id: List of gene trait association id. e.g.
992
- 'umls:C0007222' , 'OMIM:269600'.
993
- :param str go: List of GO (Gene Ontology) terms. e.g. 'GO:0002020'.
994
- :param str expression: List of tissues of interest. e.g. 'lung'.
995
- :param str protein_keyword: List of Uniprot protein variant annotation
996
- keywords.
997
- :param str drug: List of drug names.
998
- :param str functional_score: Functional score:
999
- {functional_score}[<|>|<=|>=]{number} e.g. cadd_scaled>5.2 ,
1000
- cadd_raw<=0.3.
1001
- :param str clinical: Clinical source: clinvar, cosmic.
1002
- :param str clinical_significance: Clinical significance: benign,
1003
- likely_benign, likely_pathogenic, pathogenic.
1004
- :param bool clinical_confirmed_status: Clinical confirmed status.
1005
- :param str custom_annotation: Custom annotation:
1006
- {key}[<|>|<=|>=]{number} or {key}[~=|=]{text}.
1007
- :param str panel: Filter by genes from the given disease panel.
1008
- :param str panel_mode_of_inheritance: Filter genes from specific
1009
- panels that match certain mode of inheritance. Accepted values : [
1010
- autosomalDominant, autosomalRecessive, XLinkedDominant,
1011
- XLinkedRecessive, YLinked, mitochondrial, deNovo, mendelianError,
1012
- compoundHeterozygous ].
1013
- :param str panel_confidence: Filter genes from specific panels that
1014
- match certain confidence. Accepted values : [ high, medium, low,
1015
- rejected ].
1016
- :param str panel_role_in_cancer: Filter genes from specific panels
1017
- that match certain role in cancer. Accepted values : [ both,
1018
- oncogene, tumorSuppressorGene, fusion ].
1019
- :param str panel_feature_type: Filter elements from specific panels by
1020
- type. Accepted values : [ gene, region, str, variant ].
1021
- :param bool panel_intersection: Intersect panel genes and regions with
1022
- given genes and regions from que input query. This will prevent
1023
- returning variants from regions out of the panel.
1024
- :param str source: Select the variant data source from where to fetch
1025
- the data. Accepted values are 'variant_index' (default) and
1026
- 'secondary_sample_index'. When selecting a secondary_index, the
1027
- data will be retrieved exclusively from that secondary index, and
1028
- the 'include/exclude' parameters will be ignored. If the given
1029
- query can not be fully resolved using the secondary index, an
1030
- exception will be raised. As the returned variants will only
1031
- contain data from the secondary_index, some data might be missing
1032
- or be partial.
1033
- :param str trait: List of traits, based on ClinVar, HPO, COSMIC, i.e.:
1034
- IDs, histologies, descriptions,...
1035
- """
1036
-
1037
- return self._get(category='analysis', resource='query', subcategory='clinical/variant', **options)
1038
-
1039
- def acl(self, clinical_analyses, **options):
1040
- """
1041
- Returns the acl of the clinical analyses. If member is provided, it
1042
- will only return the acl for the member.
1043
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalyses}/acl
1044
-
1045
- :param str clinical_analyses: Comma separated list of clinical
1046
- analysis IDs or names up to a maximum of 100. (REQUIRED)
1047
- :param str study: Study [[organization@]project:]study where study and
1048
- project can be either the ID or UUID.
1049
- :param str member: User or group ID.
1050
- :param bool silent: Boolean to retrieve all possible entries that are
1051
- queried for, false to raise an exception whenever one of the
1052
- entries looked for cannot be shown for whichever reason.
1053
- """
1054
-
1055
- return self._get(category='analysis', resource='acl', subcategory='clinical', second_query_id=clinical_analyses, **options)
1056
-
1057
- def delete(self, clinical_analyses, **options):
1058
- """
1059
- Delete clinical analyses.
1060
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalyses}/delete
1061
-
1062
- :param str clinical_analyses: Comma separated list of clinical
1063
- analysis IDs or names up to a maximum of 100. (REQUIRED)
1064
- :param str study: Study [[organization@]project:]study where study and
1065
- project can be either the ID or UUID.
1066
- :param bool force: Force deletion if the ClinicalAnalysis contains
1067
- interpretations or is locked.
1068
- """
1069
-
1070
- return self._delete(category='analysis', resource='delete', subcategory='clinical', second_query_id=clinical_analyses, **options)
1071
-
1072
- def update(self, clinical_analyses, data=None, **options):
1073
- """
1074
- Update clinical analysis attributes.
1075
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalyses}/update
1076
-
1077
- :param dict data: JSON containing clinical analysis information.
1078
- (REQUIRED)
1079
- :param str clinical_analyses: Comma separated list of clinical
1080
- analysis IDs. (REQUIRED)
1081
- :param str include: Fields included in the response, whole JSON path
1082
- must be provided.
1083
- :param str exclude: Fields excluded in the response, whole JSON path
1084
- must be provided.
1085
- :param str study: Study [[organization@]project:]study where study and
1086
- project can be either the ID or UUID.
1087
- :param str comments_action: Action to be performed if the array of
1088
- comments is being updated. Allowed values: ['ADD REMOVE REPLACE']
1089
- :param str flags_action: Action to be performed if the array of flags
1090
- is being updated. Allowed values: ['ADD SET REMOVE']
1091
- :param str analysts_action: Action to be performed if the array of
1092
- analysts is being updated. Allowed values: ['ADD SET REMOVE']
1093
- :param str files_action: Action to be performed if the array of files
1094
- is being updated. Allowed values: ['ADD SET REMOVE']
1095
- :param str panels_action: Action to be performed if the array of
1096
- panels is being updated. Allowed values: ['ADD SET REMOVE']
1097
- :param str annotation_sets_action: Action to be performed if the array
1098
- of annotationSets is being updated. Allowed values: ['ADD SET
1099
- REMOVE']
1100
- :param bool include_result: Flag indicating to include the created or
1101
- updated document result in the response.
1102
- """
1103
-
1104
- return self._post(category='analysis', resource='update', subcategory='clinical', second_query_id=clinical_analyses, data=data, **options)
1105
-
1106
- def update_annotation_sets_annotations(self, clinical_analysis, annotation_set, data=None, **options):
1107
- """
1108
- Update annotations from an annotationSet.
1109
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/annotationSets/{annotationSet}/annotations/update
1110
-
1111
- :param str annotation_set: AnnotationSet ID to be updated. (REQUIRED)
1112
- :param str clinical_analysis: Clinical analysis ID. (REQUIRED)
1113
- :param str study: Study [[organization@]project:]study where study and
1114
- project can be either the ID or UUID.
1115
- :param str action: Action to be performed: ADD to add new annotations;
1116
- REPLACE to replace the value of an already existing annotation; SET
1117
- to set the new list of annotations removing any possible old
1118
- annotations; REMOVE to remove some annotations; RESET to set some
1119
- annotations to the default value configured in the corresponding
1120
- variables of the VariableSet if any. Allowed values: ['ADD SET
1121
- REMOVE RESET REPLACE']
1122
- :param dict data: Json containing the map of annotations when the
1123
- action is ADD, SET or REPLACE, a json with only the key 'remove'
1124
- containing the comma separated variables to be removed as a value
1125
- when the action is REMOVE or a json with only the key 'reset'
1126
- containing the comma separated variables that will be set to the
1127
- default value when the action is RESET.
1128
- """
1129
-
1130
- return self._post(category='analysis/clinical', resource='annotations/update', query_id=clinical_analysis, subcategory='annotationSets', second_query_id=annotation_set, data=data, **options)
1131
-
1132
- def info(self, clinical_analysis, **options):
1133
- """
1134
- Clinical analysis info.
1135
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/info
1136
-
1137
- :param str clinical_analysis: Comma separated list of clinical
1138
- analysis IDs or names up to a maximum of 100. (REQUIRED)
1139
- :param str include: Fields included in the response, whole JSON path
1140
- must be provided.
1141
- :param str exclude: Fields excluded in the response, whole JSON path
1142
- must be provided.
1143
- :param bool flatten_annotations: Flatten the annotations?.
1144
- :param str study: Study [[organization@]project:]study where study and
1145
- project can be either the ID or UUID.
1146
- :param str version: Comma separated list of clinical versions. 'all'
1147
- to get all the clinical versions. Not supported if multiple
1148
- clinical ids are provided.
1149
- :param bool deleted: Boolean to retrieve deleted entries.
1150
- """
1151
-
1152
- return self._get(category='analysis', resource='info', subcategory='clinical', second_query_id=clinical_analysis, **options)
1153
-
1154
- def create_interpretation(self, clinical_analysis, data=None, **options):
1155
- """
1156
- Create a new Interpretation.
1157
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/interpretation/create
1158
-
1159
- :param dict data: JSON containing clinical interpretation information.
1160
- (REQUIRED)
1161
- :param str clinical_analysis: Clinical analysis ID. (REQUIRED)
1162
- :param str include: Fields included in the response, whole JSON path
1163
- must be provided.
1164
- :param str exclude: Fields excluded in the response, whole JSON path
1165
- must be provided.
1166
- :param str study: [[organization@]project:]study id.
1167
- :param str set_as: Set interpretation as. Allowed values: ['PRIMARY
1168
- SECONDARY']
1169
- :param bool include_result: Flag indicating to include the created or
1170
- updated document result in the response.
1171
- """
1172
-
1173
- return self._post(category='analysis/clinical', resource='create', query_id=clinical_analysis, subcategory='interpretation', data=data, **options)
1174
-
1175
- def clear_interpretation(self, clinical_analysis, interpretations, **options):
1176
- """
1177
- Clear the fields of the main interpretation of the Clinical Analysis.
1178
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/interpretation/{interpretations}/clear
1179
-
1180
- :param str clinical_analysis: Clinical analysis ID. (REQUIRED)
1181
- :param str interpretations: Interpretation IDs of the Clinical
1182
- Analysis. (REQUIRED)
1183
- :param str study: [[organization@]project:]study ID.
1184
- """
1185
-
1186
- return self._post(category='analysis/clinical', resource='clear', query_id=clinical_analysis, subcategory='interpretation', second_query_id=interpretations, **options)
1187
-
1188
- def delete_interpretation(self, clinical_analysis, interpretations, **options):
1189
- """
1190
- Delete interpretation.
1191
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/interpretation/{interpretations}/delete
1192
-
1193
- :param str interpretations: Interpretation IDs of the Clinical
1194
- Analysis. (REQUIRED)
1195
- :param str clinical_analysis: Clinical analysis ID. (REQUIRED)
1196
- :param str study: [[organization@]project:]study ID.
1197
- :param str set_as_primary: Interpretation id to set as primary from
1198
- the list of secondaries in case of deleting the actual primary one.
1199
- """
1200
-
1201
- return self._delete(category='analysis/clinical', resource='delete', query_id=clinical_analysis, subcategory='interpretation', second_query_id=interpretations, **options)
1202
-
1203
- def revert_interpretation(self, clinical_analysis, interpretation, version, **options):
1204
- """
1205
- Revert to a previous interpretation version.
1206
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/interpretation/{interpretation}/revert
1207
-
1208
- :param int version: Version to revert to. (REQUIRED)
1209
- :param str interpretation: Interpretation ID. (REQUIRED)
1210
- :param str clinical_analysis: Clinical analysis ID. (REQUIRED)
1211
- :param str study: [[organization@]project:]study ID.
1212
- """
1213
-
1214
- options['version'] = version
1215
- return self._post(category='analysis/clinical', resource='revert', query_id=clinical_analysis, subcategory='interpretation', second_query_id=interpretation, **options)
1216
-
1217
- def update_interpretation(self, clinical_analysis, interpretation, data=None, **options):
1218
- """
1219
- Update interpretation fields.
1220
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/interpretation/{interpretation}/update
1221
-
1222
- :param dict data: JSON containing clinical interpretation information.
1223
- (REQUIRED)
1224
- :param str interpretation: Interpretation ID. (REQUIRED)
1225
- :param str clinical_analysis: Clinical analysis ID. (REQUIRED)
1226
- :param str include: Fields included in the response, whole JSON path
1227
- must be provided.
1228
- :param str exclude: Fields excluded in the response, whole JSON path
1229
- must be provided.
1230
- :param str study: [[organization@]project:]study ID.
1231
- :param str primary_findings_action: Action to be performed if the
1232
- array of primary findings is being updated. Allowed values: ['ADD
1233
- SET REMOVE REPLACE']
1234
- :param str methods_action: Action to be performed if the array of
1235
- methods is being updated. Allowed values: ['ADD SET REMOVE']
1236
- :param str secondary_findings_action: Action to be performed if the
1237
- array of secondary findings is being updated. Allowed values: ['ADD
1238
- SET REMOVE REPLACE']
1239
- :param str comments_action: Action to be performed if the array of
1240
- comments is being updated. To REMOVE or REPLACE, the date will need
1241
- to be provided to identify the comment. Allowed values: ['ADD
1242
- REMOVE REPLACE']
1243
- :param str panels_action: Action to be performed if the array of
1244
- panels is being updated. Allowed values: ['ADD SET REMOVE']
1245
- :param str set_as: Set interpretation as. Allowed values: ['PRIMARY
1246
- SECONDARY']
1247
- :param bool include_result: Flag indicating to include the created or
1248
- updated document result in the response.
1249
- """
1250
-
1251
- return self._post(category='analysis/clinical', resource='update', query_id=clinical_analysis, subcategory='interpretation', second_query_id=interpretation, data=data, **options)
1252
-
1253
- def update_report(self, clinical_analysis, data=None, **options):
1254
- """
1255
- Update clinical analysis report.
1256
- PATH: /{apiVersion}/analysis/clinical/{clinicalAnalysis}/report/update
1257
-
1258
- :param dict data: JSON containing clinical report information.
1259
- (REQUIRED)
1260
- :param str clinical_analysis: Clinical analysis ID. (REQUIRED)
1261
- :param str include: Fields included in the response, whole JSON path
1262
- must be provided.
1263
- :param str exclude: Fields excluded in the response, whole JSON path
1264
- must be provided.
1265
- :param str study: Study [[organization@]project:]study where study and
1266
- project can be either the ID or UUID.
1267
- :param str comments_action: Action to be performed if the array of
1268
- comments is being updated. Allowed values: ['ADD REMOVE REPLACE']
1269
- :param str supporting_evidences_action: Action to be performed if the
1270
- array of supporting evidences is being updated. Allowed values:
1271
- ['ADD SET REMOVE']
1272
- :param str files_action: Action to be performed if the array of files
1273
- is being updated. Allowed values: ['ADD SET REMOVE']
1274
- :param bool include_result: Flag indicating to include the created or
1275
- updated document result in the response.
1276
- """
1277
-
1278
- return self._post(category='analysis/clinical', resource='update', query_id=clinical_analysis, subcategory='report', data=data, **options)
1279
-