@sjcrh/proteinpaint-types 2.106.0 → 2.108.0

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.
package/dist/burden.js CHANGED
@@ -2,7 +2,7 @@ import {
2
2
  burdenPayload,
3
3
  validBurdenRequest,
4
4
  validBurdenResponse
5
- } from "./chunk-RLFGMVJZ.js";
5
+ } from "./chunk-GHD26RNJ.js";
6
6
  import "./chunk-Z6B6IQIY.js";
7
7
  export {
8
8
  burdenPayload,
@@ -3328,31 +3328,53 @@ var validCorrelationVolcanoRequest = (input) => {
3328
3328
  var validCorrelationVolcanoResponse = (input) => {
3329
3329
  const errors = [];
3330
3330
  const __is = (input2) => {
3331
- const $io0 = (input3) => Array.isArray(input3.variableItems) && input3.variableItems.every((elem) => "object" === typeof elem && null !== elem && $io1(elem));
3332
- const $io1 = (input3) => "number" === typeof input3.correlation && "number" === typeof input3.original_pvalue && "number" === typeof input3.adjusted_pvalue && "string" === typeof input3.tw$id && "number" === typeof input3.sampleSize;
3331
+ const $io0 = (input3) => Array.isArray(input3.skippedVariables) && input3.skippedVariables.every((elem) => "object" === typeof elem && null !== elem && $io1(elem)) && (Array.isArray(input3.variableItems) && input3.variableItems.every((elem) => "object" === typeof elem && null !== elem && $io2(elem)));
3332
+ const $io1 = (input3) => "string" === typeof input3.tw$id;
3333
+ const $io2 = (input3) => "number" === typeof input3.correlation && "number" === typeof input3.original_pvalue && "number" === typeof input3.adjusted_pvalue && "string" === typeof input3.tw$id && "number" === typeof input3.sampleSize;
3333
3334
  return "object" === typeof input2 && null !== input2 && $io0(input2);
3334
3335
  };
3335
3336
  if (false === __is(input)) {
3336
3337
  const $report = import_typia.createValidate.report(errors);
3337
3338
  ((input2, _path, _exceptionable = true) => {
3338
- const $vo0 = (input3, _path2, _exceptionable2 = true) => [(Array.isArray(input3.variableItems) || $report(_exceptionable2, {
3339
- path: _path2 + ".variableItems",
3339
+ const $vo0 = (input3, _path2, _exceptionable2 = true) => [(Array.isArray(input3.skippedVariables) || $report(_exceptionable2, {
3340
+ path: _path2 + ".skippedVariables",
3340
3341
  expected: "Array<__type>",
3341
- value: input3.variableItems
3342
- })) && input3.variableItems.map((elem, _index1) => ("object" === typeof elem && null !== elem || $report(_exceptionable2, {
3343
- path: _path2 + ".variableItems[" + _index1 + "]",
3342
+ value: input3.skippedVariables
3343
+ })) && input3.skippedVariables.map((elem, _index1) => ("object" === typeof elem && null !== elem || $report(_exceptionable2, {
3344
+ path: _path2 + ".skippedVariables[" + _index1 + "]",
3344
3345
  expected: "__type",
3345
3346
  value: elem
3346
- })) && $vo1(elem, _path2 + ".variableItems[" + _index1 + "]", _exceptionable2) || $report(_exceptionable2, {
3347
- path: _path2 + ".variableItems[" + _index1 + "]",
3347
+ })) && $vo1(elem, _path2 + ".skippedVariables[" + _index1 + "]", _exceptionable2) || $report(_exceptionable2, {
3348
+ path: _path2 + ".skippedVariables[" + _index1 + "]",
3348
3349
  expected: "__type",
3349
3350
  value: elem
3350
3351
  })).every((flag) => flag) || $report(_exceptionable2, {
3351
- path: _path2 + ".variableItems",
3352
+ path: _path2 + ".skippedVariables",
3352
3353
  expected: "Array<__type>",
3354
+ value: input3.skippedVariables
3355
+ }), (Array.isArray(input3.variableItems) || $report(_exceptionable2, {
3356
+ path: _path2 + ".variableItems",
3357
+ expected: "Array<__type>.o1",
3353
3358
  value: input3.variableItems
3359
+ })) && input3.variableItems.map((elem, _index2) => ("object" === typeof elem && null !== elem || $report(_exceptionable2, {
3360
+ path: _path2 + ".variableItems[" + _index2 + "]",
3361
+ expected: "__type.o1",
3362
+ value: elem
3363
+ })) && $vo2(elem, _path2 + ".variableItems[" + _index2 + "]", _exceptionable2) || $report(_exceptionable2, {
3364
+ path: _path2 + ".variableItems[" + _index2 + "]",
3365
+ expected: "__type.o1",
3366
+ value: elem
3367
+ })).every((flag) => flag) || $report(_exceptionable2, {
3368
+ path: _path2 + ".variableItems",
3369
+ expected: "Array<__type>.o1",
3370
+ value: input3.variableItems
3371
+ })].every((flag) => flag);
3372
+ const $vo1 = (input3, _path2, _exceptionable2 = true) => ["string" === typeof input3.tw$id || $report(_exceptionable2, {
3373
+ path: _path2 + ".tw$id",
3374
+ expected: "string",
3375
+ value: input3.tw$id
3354
3376
  })].every((flag) => flag);
3355
- const $vo1 = (input3, _path2, _exceptionable2 = true) => ["number" === typeof input3.correlation || $report(_exceptionable2, {
3377
+ const $vo2 = (input3, _path2, _exceptionable2 = true) => ["number" === typeof input3.correlation || $report(_exceptionable2, {
3356
3378
  path: _path2 + ".correlation",
3357
3379
  expected: "number",
3358
3380
  value: input3.correlation
@@ -21,7 +21,7 @@ var genesetEnrichmentPayload = {
21
21
  var validGenesetEnrichmentRequest = (input) => {
22
22
  const errors = [];
23
23
  const __is = (input2) => {
24
- const $io0 = (input3) => Array.isArray(input3.genes) && input3.genes.every((elem) => "string" === typeof elem) && (Array.isArray(input3.fold_change) && input3.fold_change.every((elem) => "number" === typeof elem)) && "boolean" === typeof input3.filter_non_coding_genes && "string" === typeof input3.genome && "string" === typeof input3.geneSetGroup && (void 0 === input3.geneset_name || "string" === typeof input3.geneset_name) && (void 0 === input3.pickle_file || "string" === typeof input3.pickle_file) && (void 0 === input3.num_permutations || "number" === typeof input3.num_permutations);
24
+ const $io0 = (input3) => Array.isArray(input3.genes) && input3.genes.every((elem) => "string" === typeof elem) && (Array.isArray(input3.fold_change) && input3.fold_change.every((elem) => "number" === typeof elem)) && "boolean" === typeof input3.filter_non_coding_genes && "string" === typeof input3.genome && "string" === typeof input3.geneSetGroup && (void 0 === input3.geneset_name || "string" === typeof input3.geneset_name) && (void 0 === input3.pickle_file || "string" === typeof input3.pickle_file) && "number" === typeof input3.num_permutations;
25
25
  return "object" === typeof input2 && null !== input2 && $io0(input2);
26
26
  };
27
27
  if (false === __is(input)) {
@@ -71,9 +71,9 @@ var validGenesetEnrichmentRequest = (input) => {
71
71
  path: _path2 + ".pickle_file",
72
72
  expected: "(string | undefined)",
73
73
  value: input3.pickle_file
74
- }), void 0 === input3.num_permutations || "number" === typeof input3.num_permutations || $report(_exceptionable2, {
74
+ }), "number" === typeof input3.num_permutations || $report(_exceptionable2, {
75
75
  path: _path2 + ".num_permutations",
76
- expected: "(number | undefined)",
76
+ expected: "number",
77
77
  value: input3.num_permutations
78
78
  })].every((flag) => flag);
79
79
  return ("object" === typeof input2 && null !== input2 || $report(true, {
@@ -53,7 +53,7 @@ var burdenPayload = {
53
53
  var validBurdenRequest = (input) => {
54
54
  const errors = [];
55
55
  const __is = (input2) => {
56
- const $io0 = (input3) => "string" === typeof input3.genome && "string" === typeof input3.dslabel && "number" === typeof input3.diaggrp && "number" === typeof input3.sex && "number" === typeof input3.white && "number" === typeof input3.agedx && "number" === typeof input3.bleo && "number" === typeof input3.etop && "number" === typeof input3.cisp && "number" === typeof input3.carbo && "number" === typeof input3.steriod && "number" === typeof input3.vcr && "number" === typeof input3.hdmtx && "number" === typeof input3.itmt && "number" === typeof input3.ced && "number" === typeof input3.dox && "number" === typeof input3.heart && "number" === typeof input3.brain && "number" === typeof input3.abd && "number" === typeof input3.pelvis && "number" === typeof input3.chest;
56
+ const $io0 = (input3) => "string" === typeof input3.genome && "string" === typeof input3.dslabel && "boolean" === typeof input3.showCI && "number" === typeof input3.diaggrp && "number" === typeof input3.sex && "number" === typeof input3.white && "number" === typeof input3.agedx && "number" === typeof input3.bleo && "number" === typeof input3.etop && "number" === typeof input3.cisp && "number" === typeof input3.carbo && "number" === typeof input3.steriod && "number" === typeof input3.vcr && "number" === typeof input3.hdmtx && "number" === typeof input3.itmt && "number" === typeof input3.ced && "number" === typeof input3.dox && "number" === typeof input3.heart && "number" === typeof input3.brain && "number" === typeof input3.abd && "number" === typeof input3.pelvis && "number" === typeof input3.chest;
57
57
  return "object" === typeof input2 && null !== input2 && $io0(input2);
58
58
  };
59
59
  if (false === __is(input)) {
@@ -67,6 +67,10 @@ var validBurdenRequest = (input) => {
67
67
  path: _path2 + ".dslabel",
68
68
  expected: "string",
69
69
  value: input3.dslabel
70
+ }), "boolean" === typeof input3.showCI || $report(_exceptionable2, {
71
+ path: _path2 + ".showCI",
72
+ expected: "boolean",
73
+ value: input3.showCI
70
74
  }), "number" === typeof input3.diaggrp || $report(_exceptionable2, {
71
75
  path: _path2 + ".diaggrp",
72
76
  expected: "number",
@@ -2,7 +2,7 @@ import {
2
2
  CorrelationVolcanoPayload,
3
3
  validCorrelationVolcanoRequest,
4
4
  validCorrelationVolcanoResponse
5
- } from "./chunk-FUIYK4TP.js";
5
+ } from "./chunk-2R2EFRAW.js";
6
6
  import "./chunk-Z6B6IQIY.js";
7
7
  export {
8
8
  CorrelationVolcanoPayload,
@@ -2,7 +2,7 @@ import {
2
2
  genesetEnrichmentPayload,
3
3
  validGenesetEnrichmentRequest,
4
4
  validGenesetEnrichmentResponse
5
- } from "./chunk-XILU2DZ4.js";
5
+ } from "./chunk-ERA5PPKH.js";
6
6
  import "./chunk-Z6B6IQIY.js";
7
7
  export {
8
8
  genesetEnrichmentPayload,
package/dist/index.js CHANGED
@@ -172,7 +172,7 @@ import {
172
172
  genesetEnrichmentPayload,
173
173
  validGenesetEnrichmentRequest,
174
174
  validGenesetEnrichmentResponse
175
- } from "./chunk-XILU2DZ4.js";
175
+ } from "./chunk-ERA5PPKH.js";
176
176
  import {
177
177
  genesetOverrepresentationPayload,
178
178
  validGenesetOverrepresentationRequest,
@@ -202,7 +202,7 @@ import {
202
202
  burdenPayload,
203
203
  validBurdenRequest,
204
204
  validBurdenResponse
205
- } from "./chunk-RLFGMVJZ.js";
205
+ } from "./chunk-GHD26RNJ.js";
206
206
  import {
207
207
  clearWSImagesSessionsPayload,
208
208
  validClearWSImagesSessionsRequest,
@@ -212,7 +212,7 @@ import {
212
212
  CorrelationVolcanoPayload,
213
213
  validCorrelationVolcanoRequest,
214
214
  validCorrelationVolcanoResponse
215
- } from "./chunk-FUIYK4TP.js";
215
+ } from "./chunk-2R2EFRAW.js";
216
216
  import {
217
217
  datasetPayload,
218
218
  validDatasetRequest,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sjcrh/proteinpaint-types",
3
- "version": "2.106.0",
3
+ "version": "2.108.0",
4
4
  "type": "module",
5
5
  "description": "Shared type definitions between ProteinPaint server and client code",
6
6
  "main": "src/index.ts",
package/src/dataset.ts CHANGED
@@ -1318,17 +1318,29 @@ type AssayAvailability = {
1318
1318
  assays?: AssaysEntry[]
1319
1319
  }
1320
1320
 
1321
+ export type CumBurdenData = {
1322
+ /** directory containing cumulative burden data */
1323
+ dir: string
1324
+ files: {
1325
+ fit: string
1326
+ surv: string
1327
+ sample: string
1328
+ }
1329
+ /** subdirectory containing bootstrap data */
1330
+ bootsubdir: string
1331
+ db: {
1332
+ /** db file created by separate repo, pcb/utils/create.sql */
1333
+ file: string
1334
+ /** sqlite connection */
1335
+ connection?: any
1336
+ }
1337
+ }
1338
+
1321
1339
  //Shared with genome.ts
1322
1340
  export type Cohort = {
1323
1341
  /** if present, means correlation volcano plot analysis is enabled */
1324
1342
  correlationVolcano?: CorrelationVolcano
1325
- cumburden?: {
1326
- files: {
1327
- fit: string
1328
- surv: string
1329
- sample: string
1330
- }
1331
- }
1343
+ cumburden?: CumBurdenData
1332
1344
  db: FileObj
1333
1345
  /** customize the default chart to open on mass ui when there's no charts. if
1334
1346
  * missing it opens dictionary ui */
@@ -5,6 +5,8 @@ export type BurdenRequest = {
5
5
  genome: string
6
6
  /** a user-defined dataset label in the serverconfig.json, such as ClinVar, SJLife, GDC, etc */
7
7
  dslabel: string
8
+ /** boolean for whether to show 95% confidence interval */
9
+ showCI: boolean
8
10
  /** the diagnosis group:
9
11
  * 1= "Acute lymphoblastic leukemia (ALL)"
10
12
  * 2= "Acute Myeloid Leukemia (AML)"
@@ -18,6 +18,11 @@ export type CorrelationVolcanoRequest = {
18
18
  }
19
19
 
20
20
  export type CorrelationVolcanoResponse = {
21
+ /** Terms with not enough vectors to calculate correlation to be shown in legend */
22
+ skippedVariables: {
23
+ /** matching tw $id */
24
+ tw$id: string
25
+ }[]
21
26
  /** each element is test result of one variable corresponding to variableTwLst */
22
27
  variableItems: {
23
28
  /** correlation coefficient, -1 to 1 */
@@ -15,8 +15,8 @@ export type GenesetEnrichmentRequest = {
15
15
  geneset_name?: string
16
16
  /** Pickle file to be queried for generating gsea image of a particular geneset */
17
17
  pickle_file?: string
18
- /** Number of permutations to be carried out for GSEA analysis, this variable will become compulsory once GSEA becomes stateless */
19
- num_permutations?: number
18
+ /** Number of permutations to be carried out for GSEA analysis */
19
+ num_permutations: number
20
20
  }
21
21
 
22
22
  type pathway_attributes = {
@@ -38,8 +38,8 @@ export type ExpressionInput = {
38
38
  storage_type: 'HDF5' | 'text'
39
39
  /** Confounding variable for DE analysis. Maybe array of string (Gender: Male/female) or number (Age). For now supporting 1 confounding variable. Later will add support for multiple confounding variables */
40
40
  conf1?: any[]
41
- /** Type of the confounding variable (categorical/float) */
42
- conf1_type?: 'categorical' | 'float'
41
+ /** Type of the confounding variable (continuous/discrete) */
42
+ conf1_mode?: 'continuous' | 'discrete'
43
43
  /** Number of variable genes to be included for DE analysis (optional) */
44
44
  VarGenes?: number
45
45
  }