nci-cidc-schemas 0.28.2__py2.py3-none-any.whl → 0.28.3__py2.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.
cidc_schemas/__init__.py CHANGED
@@ -2,4 +2,4 @@
2
2
 
3
3
  __author__ = """NCI"""
4
4
  __email__ = "nci-cidc-tools-admin@mail.nih.gov"
5
- __version__ = "0.28.2"
5
+ __version__ = "0.28.3"
@@ -28,6 +28,7 @@ SUPPORTED_ASSAYS = [
28
28
  "mihc",
29
29
  "scrnaseq",
30
30
  "visium",
31
+ "nulisa",
31
32
  ]
32
33
 
33
34
  SUPPORTED_SHIPPING_MANIFESTS = [
@@ -143,6 +144,7 @@ ASSAY_TO_FILEPATH: Dict[str, str] = {
143
144
  "scrnaseq_analysis",
144
145
  "visium",
145
146
  "visium_analysis",
147
+ "nulisa",
146
148
  ]
147
149
  },
148
150
  }
@@ -167,6 +167,17 @@
167
167
  "$ref": "assays/microbiome_assay.json"
168
168
  },
169
169
  "mergeStrategy": "append"
170
+ },
171
+ "nulisa": {
172
+ "type": "array",
173
+ "description": "NULISA",
174
+ "items": {
175
+ "$ref": "assays/nulisa_assay.json"
176
+ },
177
+ "mergeStrategy": "arrayMergeById",
178
+ "mergeOptions": {
179
+ "idRef": "batch_id"
180
+ }
170
181
  }
171
182
  }
172
183
  }
@@ -0,0 +1,46 @@
1
+ {
2
+ "$schema": "metaschema/strict_meta_schema.json#",
3
+ "$id": "nulisa_input",
4
+ "title": "NULISA Input Files and Data",
5
+ "type": "object",
6
+ "description": "NULISA assay input files and data",
7
+ "inheritableBase": true,
8
+ "properties": {
9
+ "ic_median": {
10
+ "description": "Percentage sample IC reads relative to the median (within +/- 40% of the plate median)",
11
+ "type": "number"
12
+ },
13
+ "detectability": {
14
+ "description": "Percentage of targets with reads above the Limit of Detection (LOD) (Minimum threshold = plasma-90%, serum-90%, csf-70%, other-0%)",
15
+ "type": "number"
16
+ },
17
+ "ic_reads": {
18
+ "description": "Number of Internal Control (IC) reads within a sample (Minimum threshold = 1,000)",
19
+ "type": "integer"
20
+ },
21
+ "qc_status": {
22
+ "description": "Status",
23
+ "type": "string",
24
+ "enum": [
25
+ "warning",
26
+ "passed",
27
+ "NA"
28
+ ]
29
+ },
30
+ "reads": {
31
+ "description": "Number of reads within a sample (Minimum threshold = 500,000)",
32
+ "type": "integer"
33
+ },
34
+ "auto_well_position": {
35
+ "description": "Auto well position label",
36
+ "type": "string"
37
+ }
38
+ },
39
+ "required": [
40
+ "ic_median",
41
+ "ic_reads",
42
+ "qc_status",
43
+ "reads",
44
+ "auto_well_position"
45
+ ]
46
+ }
@@ -0,0 +1,63 @@
1
+ {
2
+ "$schema": "metaschema/strict_meta_schema.json#",
3
+ "$id": "nulisa_assay",
4
+ "title": "NULISA Assay",
5
+ "type": "object",
6
+ "$comment": "description used in docs/index.html and docs/assays.nulisa.html",
7
+ "description": "Nucleic acid Linked Immuno-Sandwich Assay (NULISA) assay",
8
+ "additionalProperties": false,
9
+ "definitions": {
10
+ "record": {
11
+ "type": "object",
12
+ "mergeStrategy": "objectMerge",
13
+ "description": "A single data record from a NULISA assay.",
14
+ "additionalProperties": false,
15
+ "required": [
16
+ "cimac_id",
17
+ "details"
18
+ ],
19
+ "properties": {
20
+ "cimac_id": {
21
+ "description": "Id of an sample within this clinical trial, that this assay record is based upon.",
22
+ "$ref": "sample.json#properties/cimac_id"
23
+ },
24
+ "details": {
25
+ "$ref": "assays/components/nulisa_input.json"
26
+ }
27
+ }
28
+ }
29
+ },
30
+ "properties": {
31
+ "assay_creator": {
32
+ "$ref": "assays/components/assay_core.json#properties/assay_creator"
33
+ },
34
+ "batch_id": {
35
+ "description": "Batch identification number. Unique to every upload.",
36
+ "type": "string"
37
+ },
38
+ "npq_file": {
39
+ "$ref": "artifacts/artifact_csv.json"
40
+ },
41
+ "raw_counts_file": {
42
+ "$ref": "artifacts/artifact_csv.json"
43
+ },
44
+ "metadata_csv": {"$ref": "artifacts/artifact_csv.json"},
45
+
46
+
47
+ "records": {
48
+ "type": "array",
49
+ "description": "A single data record from a NULISA assay.",
50
+ "items": {
51
+ "$ref": "assays/nulisa_assay.json#definitions/record"
52
+ },
53
+ "mergeStrategy": "append"
54
+ }
55
+ },
56
+ "required": [
57
+ "assay_creator",
58
+ "batch_id",
59
+ "npq_file",
60
+ "raw_counts_file",
61
+ "records"
62
+ ]
63
+ }
@@ -0,0 +1,88 @@
1
+ {
2
+ "title": "NULISA assay template",
3
+ "description": "NULISA submission.",
4
+ "prism_template_root_object_schema": "assays/nulisa_assay.json",
5
+ "prism_template_root_object_pointer": "/assays/nulisa/0",
6
+ "properties":
7
+ {
8
+ "worksheets":
9
+ {
10
+ "NULISA":
11
+ {
12
+ "preamble_rows":
13
+ {
14
+ "protocol identifier":
15
+ {
16
+ "merge_pointer": "3/protocol_identifier",
17
+ "type_ref": "clinical_trial.json#properties/protocol_identifier"
18
+ },
19
+ "assay creator":
20
+ {
21
+ "merge_pointer": "0/assay_creator",
22
+ "type_ref": "assays/scrnaseq_assay.json#properties/assay_creator"
23
+ },
24
+ "batch id": {
25
+ "merge_pointer": "0/batch_id",
26
+ "type_ref": "assays/scrnaseq_assay.json#properties/batch_id"
27
+ },
28
+ "npq file": {
29
+ "merge_pointer": "0/npq_file",
30
+ "gcs_uri_format": "{protocol identifier}/nulisa/{batch id}/npq_file.csv",
31
+ "is_artifact": 1,
32
+ "type_ref": "assays/components/local_file.json#properties/file_path"
33
+ },
34
+ "raw counts file": {
35
+ "merge_pointer": "0/raw_counts_file",
36
+ "gcs_uri_format": "{protocol identifier}/nulisa/{batch id}/raw_counts_file.csv",
37
+ "is_artifact": 1,
38
+ "type_ref": "assays/components/local_file.json#properties/file_path"
39
+ },
40
+ "metadata csv": {
41
+ "merge_pointer": "0/metadata_csv",
42
+ "gcs_uri_format": "{protocol identifier}/nulisa/{batch id}/metadata.csv",
43
+ "is_artifact": 1,
44
+ "type_ref": "assays/components/local_file.json#properties/file_path",
45
+ "allow_empty": true
46
+ }
47
+ },
48
+ "prism_data_object_pointer": "/records/-",
49
+ "data_columns":
50
+ {
51
+ "Samples":
52
+ {
53
+ "Cimac ID":
54
+ {
55
+ "merge_pointer": "0/cimac_id",
56
+ "type_ref": "sample.json#properties/cimac_id"
57
+ },
58
+ "IC Median": {
59
+ "merge_pointer": "0/details/ic_median",
60
+ "type": "number"
61
+ },
62
+ "Detectability": {
63
+ "merge_pointer": "0/details/detectability",
64
+ "type": "number",
65
+ "allow_empty": true
66
+ },
67
+ "IC Reads": {
68
+ "merge_pointer": "0/details/ic_reads",
69
+ "type": "integer"
70
+ },
71
+ "QC Status": {
72
+ "merge_pointer": "0/details/qc_status",
73
+ "type": "string"
74
+ },
75
+ "Reads": {
76
+ "merge_pointer": "0/details/reads",
77
+ "type": "integer"
78
+ },
79
+ "AUTO_WELLPOSITION": {
80
+ "merge_pointer": "0/details/auto_well_position",
81
+ "type": "string"
82
+ }
83
+ }
84
+ }
85
+ }
86
+ }
87
+ }
88
+ }
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nci_cidc_schemas
3
- Version: 0.28.2
3
+ Version: 0.28.3
4
4
  Summary: The CIDC data model and tools for working with it.
5
5
  Home-page: https://github.com/NCI-CIDC/cidc-schemas
6
6
  Author: NCI
@@ -1,4 +1,4 @@
1
- cidc_schemas/__init__.py,sha256=dMTFW_ybl5DgOcuxwoI6PTPfawBCG_1eI-2rx8jd4kY,135
1
+ cidc_schemas/__init__.py,sha256=ZhhU8G6vhZDwCRTjZUSvsWDgfM9KmaaVdhcContfbVo,135
2
2
  cidc_schemas/cli.py,sha256=gWiktRlraNH8Q0zNUae9dohKjPwBmcY0BJwdcQ_fIic,4099
3
3
  cidc_schemas/constants.py,sha256=RULs7pGuBAVq1teXymrfbVsK23ZowJvLuZlv0KcjL-Y,698
4
4
  cidc_schemas/json_validation.py,sha256=4UxcYrofXlDT-Lz6uiQGO1Jwz5bRs0mN_UH4p_A84ks,23262
@@ -28,7 +28,7 @@ cidc_schemas/ngs_pipeline_api/wes/wes_tumor_only_output_API.json,sha256=BxRIHrhu
28
28
  cidc_schemas/ngs_pipeline_api/wes/imgs/wes.png,sha256=QQPDqTUSOgaS6s0bLu2g2y_WQgVoujtwDTF9z5xZKCE,403116
29
29
  cidc_schemas/pipeline_configs/rna_level1_analysis_config.yaml.j2,sha256=6no9sFqwzb1T61RZGD-owDt2K5R8G_fPTzflV4fOroo,2832
30
30
  cidc_schemas/prism/__init__.py,sha256=J5Tj0X7Di6cyxAjaduOUp2aVyvl8UI67bgxEkgttvcU,530
31
- cidc_schemas/prism/constants.py,sha256=PevSn-geY8VTGMx1iXdUJ2LgoeuhEdKfIpZYk_LbzwI,4088
31
+ cidc_schemas/prism/constants.py,sha256=5Gr6xD_XrJpR7g6WC-twIEzaSnG7Oa1p09kDNWvDx5c,4124
32
32
  cidc_schemas/prism/core.py,sha256=tXDCCHurvcrxfU11meH3NRAVo9niklup0dpLRoIXwPk,20242
33
33
  cidc_schemas/prism/extra_metadata.py,sha256=2qs2PCvWRknZk56GrnRCjQ2hifAQz2YcJ8qXeMlG-Zg,8769
34
34
  cidc_schemas/prism/merger.py,sha256=36CKBPVoWecHuvGp3oT9a2d4jWIkvKuS_UofKTEpMYs,13065
@@ -99,6 +99,7 @@ cidc_schemas/schemas/assays/mif_assay.json,sha256=IG-s80kl8PUUi4U6FGmJbziG0nJf5O
99
99
  cidc_schemas/schemas/assays/mihc_assay.json,sha256=OgcklPvtUoCB-Gdvg4DF9fHFI15h9oalGW9lB4SL4xc,3104
100
100
  cidc_schemas/schemas/assays/misc_data.json,sha256=R6q-B8E-fIihlDNbe34gy7_aQeU1eIL9R_Yolg8SotU,2005
101
101
  cidc_schemas/schemas/assays/nanostring_assay.json,sha256=XAL6n80sxaAwUcNrx-pgA_YC5tyOlJrHOi8ID2vnFBo,2599
102
+ cidc_schemas/schemas/assays/nulisa_assay.json,sha256=CMiAr-TsqRB6R6UcfWjjMrilN9vAQNSBcnv-vo3gPfk,2004
102
103
  cidc_schemas/schemas/assays/olink_assay.json,sha256=kQrUPjDKLKYyWpXoauiNDa0FANxPH_1bOfHeQEY-qAQ,5193
103
104
  cidc_schemas/schemas/assays/rna_assay-v0.json,sha256=skNGXbVVDY-6RpPosTHweQYtLntvo0bAiXcOxVSeh1s,3043
104
105
  cidc_schemas/schemas/assays/rna_assay.json,sha256=Gh47rRWYJSUIoLK3vvOb8_kFXhlISScrtA7nWasoBZI,409
@@ -114,7 +115,7 @@ cidc_schemas/schemas/assays/wes_core.json,sha256=dwAe2Hi-K5G0rm_icSbFUEIhDNG7HkE
114
115
  cidc_schemas/schemas/assays/wes_tumor_only_analysis.json,sha256=dU3oaeBbPnEv2Xjym7ikWr5ywwolnVbWDu1Weq2m8Wg,2018
115
116
  cidc_schemas/schemas/assays/components/antibody.json,sha256=vfLxXkXIcaJ1BXeUjCaJehrRCdVrBW3gxibwrD7zzd4,960
116
117
  cidc_schemas/schemas/assays/components/assay_core.json,sha256=QGuLiArVb7lEF2t1Ml4Qt7g4SXY58WuGBPFVgvOLI5w,485
117
- cidc_schemas/schemas/assays/components/available_assays.json,sha256=5H637v-NAAO9_RRcLyE7LlTmTfdvyQen4lstAWZTcWs,4281
118
+ cidc_schemas/schemas/assays/components/available_assays.json,sha256=A6Spi-U_YsAknrrmKbOQuZQ0HRxWhP7oWpgLAaqSUuM,4528
118
119
  cidc_schemas/schemas/assays/components/available_ngs_analyses.json,sha256=Y_CL6A5hg4w57En9q1TsLH5ZBdlFeEpE6ggb3-dIIDk,1732
119
120
  cidc_schemas/schemas/assays/components/composite_image.json,sha256=k9EaBG3y9j-lvg3nQNZbfVpo9fK_gUz1-9iTwjlTDfE,733
120
121
  cidc_schemas/schemas/assays/components/controls.json,sha256=_Wxz7W2msTGJ2Ei4XZg0Qy1t8A5_rLSHNvdPurC073E,458
@@ -132,6 +133,7 @@ cidc_schemas/schemas/assays/components/mihc_input.json,sha256=KozUg3J_0PgQm3b5EE
132
133
  cidc_schemas/schemas/assays/components/multiple_local_files.json,sha256=VVG6Yvz9yEchgFO9FHQLm7nwM_BcPMjYIecWMnRKp00,480
133
134
  cidc_schemas/schemas/assays/components/ngs_assay_core.json,sha256=jqJbrnSPZV6pmJLM6J9YAxniwqGJ_pkTLak_m9zG3nY,1229
134
135
  cidc_schemas/schemas/assays/components/ngs_assay_record.json,sha256=DwHKyRNDQ6h8PUz0KdBfmcd0Pz1Q1rOeqWpKfUIwjZM,615
136
+ cidc_schemas/schemas/assays/components/nulisa_input.json,sha256=Wu_Vx2TfwBXSaB9e9ngA7FJpcqycxwaFeyxJzosYS54,1271
135
137
  cidc_schemas/schemas/assays/components/reads_core.json,sha256=p5RWN2TEGefenpz6pZlOG6MZ6tTAviKUx1bLCZtsNLk,1139
136
138
  cidc_schemas/schemas/assays/components/reads_with_index.json,sha256=pg3wMQYMawCb1ZxJwiH_yCH3TAYu29EIZnB18AevzmM,1091
137
139
  cidc_schemas/schemas/assays/components/scrnaseq_input.json,sha256=fIvV_xJPXDCoYajbsu21ISdhLaQVYjbPg_3nR_Jo7cE,1003
@@ -176,6 +178,7 @@ cidc_schemas/schemas/templates/assays/mif_template.json,sha256=ozyMdziNxtAReTL7g
176
178
  cidc_schemas/schemas/templates/assays/mihc_template.json,sha256=BvlRCTC3R6Z6QCzqR0sH_lKuSjsd-69HWhT236aAuQQ,10974
177
179
  cidc_schemas/schemas/templates/assays/misc_data_template.json,sha256=88GBWq7hrALrYmmgfqStrhocNtPWWYOMeUk9i8_uFRg,1896
178
180
  cidc_schemas/schemas/templates/assays/nanostring_template.json,sha256=XFbf72EHNspsOUD014WDYjMSmIEz4LpCaY3iP3im2KQ,3214
181
+ cidc_schemas/schemas/templates/assays/nulisa_template.json,sha256=usOvwb-6nCGv31vblQgnrv7bnsxZvRmxcHdtFF9sWY8,3749
179
182
  cidc_schemas/schemas/templates/assays/olink_template.json,sha256=3YqkeVF9PnXUeETkf0RfEB14jprNPMWWwY4GTALfuWY,6335
180
183
  cidc_schemas/schemas/templates/assays/rna_bam_template.json,sha256=l2OLgb8hx3fAupUvdWWtn_QbOiyicYE2u4diVz7C5cg,3084
181
184
  cidc_schemas/schemas/templates/assays/rna_fastq_template.json,sha256=ZSKfzQ38SkpeKTK-xT9YAz0tRafCjo-IUZsr8GBYLOM,3344
@@ -195,9 +198,9 @@ cidc_schemas/schemas/templates/manifests/tissue_slide_template.json,sha256=q2GmO
195
198
  cidc_schemas/schemas/templates/manifests/tumor_normal_pairing_template.json,sha256=lVJrGb28n-vyfjGBzhrzjn1lMKw1b4HXXmWtwA603v0,2797
196
199
  cidc_schemas/schemas/templates/manifests/tumor_tissue_dna_template.json,sha256=LpaoDXDS11NCa-Dv37N-tzEGomswQrx5fypkUcG7xJk,18956
197
200
  cidc_schemas/schemas/templates/manifests/tumor_tissue_rna_template.json,sha256=-gww6NCHbtbI5z7UmNSmKyPK3IqKCE8F6n4XwTAb_gk,18101
198
- nci_cidc_schemas-0.28.2.dist-info/licenses/LICENSE,sha256=zK77-w4rYCZBHAYJEGkcFuPXwKIsP7jMPZ2iQOXjzko,1072
199
- nci_cidc_schemas-0.28.2.dist-info/METADATA,sha256=GKyInqelEl0ccZfhIk7i54ey1PcMYG1GtcoKYutS9lk,5008
200
- nci_cidc_schemas-0.28.2.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
201
- nci_cidc_schemas-0.28.2.dist-info/entry_points.txt,sha256=kSyTzXeJQrJp_2ZX0GS_NnbJR8ceQKLBSgER46PM0hs,55
202
- nci_cidc_schemas-0.28.2.dist-info/top_level.txt,sha256=Wwb5Cu7QrnbmSJxI2d00e3-Mir36t0jTRnSulmfhi30,13
203
- nci_cidc_schemas-0.28.2.dist-info/RECORD,,
201
+ nci_cidc_schemas-0.28.3.dist-info/licenses/LICENSE,sha256=zK77-w4rYCZBHAYJEGkcFuPXwKIsP7jMPZ2iQOXjzko,1072
202
+ nci_cidc_schemas-0.28.3.dist-info/METADATA,sha256=3GZ-RW1G6XvGLo2b3FQxSM_zIajyDBEUJSBCm4uBdDk,5008
203
+ nci_cidc_schemas-0.28.3.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
204
+ nci_cidc_schemas-0.28.3.dist-info/entry_points.txt,sha256=kSyTzXeJQrJp_2ZX0GS_NnbJR8ceQKLBSgER46PM0hs,55
205
+ nci_cidc_schemas-0.28.3.dist-info/top_level.txt,sha256=Wwb5Cu7QrnbmSJxI2d00e3-Mir36t0jTRnSulmfhi30,13
206
+ nci_cidc_schemas-0.28.3.dist-info/RECORD,,