Skip to content

Commit

Permalink
Merge pull request #379 from ncihtan/data-model-updates-for-CosMx-RFC
Browse files Browse the repository at this point in the history 
Data Model Updates for CosMx RFC
  • Loading branch information
@adamjtaylor
adamjtaylor authored Apr 29, 2024
2 parents 9a82965 + f87bf5e commit ed898f6
Show file tree
Hide file tree
Showing 2 changed files with 251 additions and 21 deletions.
17 changes: 15 additions & 2 deletions HTAN.model.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Visium File Type,The file type generated for the visium experiment.,"reference p
Run ID,A unique identifier for this individual run (typically associated with a single slide) of the spatial transcriptomic processing workflow.,,,,TRUE,Spatial Transcriptomics,,,
Capture Area,"Area (or Capture Area) - One of the either four or two active regions where tissue can be placed on a Visium slide. Each area is intended to contain only one tissue sample. Slide areas are named consecutively from top to bottom: A1, B1, C1, D1 for Visium slides with 6.5 mm Capture Area and A, B for CytAssist slides with 11 mm Capture Area. Both CytAssist slides with 6.5 mm Capture Area and Gateway Slides contain only two slide areas, A1 and D1.","A, B, C, D, A1, B1, C1, D1",,,FALSE,Spatial Transcriptomics,,,
Slide Version,Version of imaging slide used. Slide version is critical for the analysis of the sequencing data as different slides have different capture area layouts.,"V1, V2, V3, V4",,,FALSE,Spatial Transcriptomics,,,
Slide ID,"The unique identifier printed on the label of each Visium slide. The serial number starts with V followed by a number which can range between one through five and ends with a dash and a three digit number, such as 123.",,,,FALSE,Spatial Transcriptomics,,,
Slide ID,"For Visium, it is the unique identifier printed on the label of each Visium slide. The serial number starts with V followed by a number which can range between one through five and ends with a dash and a three digit number, such as 123. For CosMx, this refers to the loaded Flow Cell ID. For Xenium, this ID indicates the slide orientation, as it matches the relative location of the ID on the physical Xenium slide.",,,,FALSE,Spatial Transcriptomics,,,
Image Re-orientation,"To ensure good fiducial alignment and tissue spots detection, it is important to correct for this shift in orientation.","TRUE, FALSE",,,FALSE,Spatial Transcriptomics,,,
Permeabilization Time,Fixed and stained tissue sections are permeabilized for different times. Each Capture Area captures polyadenylated mRNA from the attached tissue section. Measure is provided in minutes.,,,,FALSE,Spatial Transcriptomics,,,
Whitelist Spatial Barcode File Link,Link to file listing all possible spatial barcodes. URL,,,,TRUE,Spatial Transcriptomics,,,
Expand Down Expand Up @@ -134,7 +134,7 @@ Scan Offset X,Offset X of the scan for GeoMx Analysis,,,,TRUE,NanoString GeoMx D
Scan Offset Y,Offset Y of the scan for GeoMx Analysis,,,,TRUE,NanoString GeoMx DSP ROI RCC Segment Annotation Metadata,,,
Binding Density,The binding density as reported by the application,,,,FALSE,NanoString GeoMx DSP ROI RCC Segment Annotation Metadata,,,
Positive norm factor,The Positive Control Normalization factor calculated using pos-hyb controls,,,,FALSE,NanoString GeoMx DSP ROI RCC Segment Annotation Metadata,,,
Surface area,Surface area of the ROI in square microns (µm2),,,,TRUE,"NanoString GeoMx DSP ROI RCC Segment Annotation Metadata, NanoString GeoMx DSP ROI DCC Segment Annotation Metadata",,,
Surface area,"Surface area of the ROI in square microns (µm^2). In CosMx, this is referred to as the Scan Area. In Xenium, this is referred to as the Region Area",,,,TRUE,"NanoString GeoMx DSP ROI RCC Segment Annotation Metadata, NanoString GeoMx DSP ROI DCC Segment Annotation Metadata",,,
Nuclei count,Number of nuclei detected in the segment (if applicable),,,,TRUE,"NanoString GeoMx DSP ROI RCC Segment Annotation Metadata, NanoString GeoMx DSP ROI DCC Segment Annotation Metadata",,,
Tissue Stain,e.g. CD45 or PanCK (if masking was performed),,,,FALSE,NanoString GeoMx DSP ROI RCC Segment Annotation Metadata,,,
NanoString GeoMx DSP ROI DCC Segment Annotation Metadata,GeoMx ROI and Segment Metadata Attributes. The assayed biospecimen should be reported one per row with the associated ROI coordinates. ,,"HTAN Parent Biospecimen ID, Scan name, Slide name, ROI name, Segment name, ROI X Coordinate,ROI Y Coordinate, Tags, Scan Height, Scan Width, Scan Offset X, Scan Offset Y, Surface area, Nuclei count, Sequencing Saturation, MapQ30, Raw reads, Stitched reads, Aligned reads, Deduplicated reads, In Situ Negative median, Biological probe median",,FALSE,Assay,,,
Expand Down Expand Up @@ -176,6 +176,19 @@ RPPA Level 2,Array based protemics. Each dilution curve of spot intensities is f
HTAN RPPA Antibody Table,A table containing antibody level metadata for RPPA,,"HTAN RPPA Antibody Table ID, Filename, File Format, Ab Name Reported on Dataset, GENCODE Gene Symbol Target, UNIPROT Protein ID Target, Phosphoprotein Flag, Vendor, Catalog Number, Internal Ab ID, Species, RPPA Dilution, Phospho Site, RPPA Validation Status, Clone, Clonality, Antibody Notes",,TRUE,RPPA Level 2,,,
RPPA Level 3,Level 3 Reverse Phase Protein Array (RPPA) data contains intra-batch normalized intensities.,,"Component, Filename, File Format, HTAN Participant ID, HTAN Parent Biospecimen ID, HTAN Parent Data File ID, HTAN Data File ID, Assay Type, Software and Version, Normalization Method",,FALSE,Assay,Biospecimen,,
RPPA Level 4,Level 4 Reverse Phase Protein Array (RPPA) data contains intra-batch corrected intensities.,,"Component, Filename, File Format, HTAN Participant ID, HTAN Parent Biospecimen ID, HTAN Parent Data File ID, HTAN Data File ID, Assay Type, Batch Correction Method",,FALSE,Assay,RPPA Level 2,,
Nanostring CosMx SMI Experiment,"RNA and Protein Panel assays applied as part of Nanostring CosMx Spatial Molecular Imager (SMI)",,"Component, Filename, File Format, HTAN Parent Biospecimen ID, HTAN Data File ID, CosMx Bundle Contents, Slide ID, CosMx Assay Type, Panel Name, Protocol Link, Software and Version, Total Number of Cells, Total Number of Targets, Number of FOVs, Surface area, Experiment IF Channels, Transcripts per Cell, Percent of Transcripts within Cells, Mean Total Transcripts per Area, Unique Genes, Total Negative Probe Counts",,FALSE,Spatial Transcriptomics,Biospecimen,,
CosMx Bundle Contents,A comma separated list of filenames within the CosMx bundle zip file,,,,TRUE,Spatial Transcriptomics,,,
CosMx Assay Type,The specification for barcodes on each image. Either RNA probe or protein antibody according to the assay,"RNA, Protein",,,TRUE,Spatial Transcriptomics,,,
Panel Name,"The human-readable panel name. This could be the Gene Panel name or Protein Panel name. In Xenium, this refers to the string entered as the name in panel specification (e.g. Xenium Human Immuno-Oncology Add-on B Gene Expression). In CosMx, this refers to the panel name as it appears in the CosMx catalog (e.g. CosMx Human Universal Cell Characterization Panel (1000-plex))",,,,TRUE,Spatial Transcriptomics,,,
Total Number of Cells,The total number of cells analyzed on the flow cell,,,,TRUE,Spatial Transcriptomics,,,
Total Number of Targets,Refers to the target of an assay. Can be genes/transcripts or probes,,,,TRUE,Spatial Transcriptomics,,,
Number of FOVs,The total number of FOVs recorded for the sample on a single flow cell,,,,TRUE,Spatial Transcriptomics,,,
Experiment IF Channels,"A comma-separated list with any number of channels the user deems appropriate(Example: PanCK, CD45, CD3, DAPI)",,,,TRUE,Spatial Transcriptomics,,,
Transcripts per Cell,Mean or Median transcript count per cell analyzed on the flow cell or slide,,,,TRUE,Spatial Transcriptomics,,,
Percent of Transcripts within Cells,The percentage of transcripts assigned to assayed cells,,,,TRUE,Spatial Transcriptomics,,,
Mean Total Transcripts per Area,The mean total transcripts per um3,,,,TRUE,Spatial Transcriptomics,,,
Unique Genes,The total unique genes detected above background,,,,FALSE,Spatial Transcriptomics,,,
Total Negative Probe Counts,Mean Total Negative probe counts/cell,,,,TRUE,Spatial Transcriptomics,,,
Mass Spectrometry Level 1,"Mass Spectrometry derived data that includes proteomics, metabolomics, and lipidomics, level 1",,"Component, Filename, File Format, HTAN Parent Biospecimen ID, HTAN Data File ID, MS Batch ID, MS-based Assay Type, Analyte Type, MS-based Targeted, MS Instrument Vendor and Model, MS Source, Polarity, Mass Range Low Value, Mass Range High Value, Data Collection Mode, MS Scan Mode, MS Labeling, Protocol Link, LC Instrument Vendor and Model, LC Column Vendor and Model, LC Resin, LC Length Value, LC Temp Value, LC ID Value, LC Flow Rate, LC Gradient, LC Mobile Phase A, LC Mobile Phase B, Software and Version, MS Instrument Metadata File",,FALSE,Assay,Biospecimen,,
Mass Spectrometry Level 2,"Mass Spectrometry derived data that includes proteomics, metabolomics, and lipidomics, level 2",,"Component, Filename, File Format, HTAN Data File ID, HTAN Parent Biospecimen ID, HTAN Parent Data File ID, MS Assay Category, Software and Version, Mass Spectrometry Auxiliary File",,FALSE,Assay,Mass Spectrometry Level 1,,
Mass Spectrometry Level 3,"Mass Spectrometry derived data that includes proteomics, metabolomics, and lipidomics, level 3",,"Component, Filename, File Format, HTAN Data File ID, HTAN Parent Biospecimen ID, HTAN Parent Data File ID, MS Assay Category, Software and Version, Mass Spectrometry Auxiliary File",,FALSE,Assay,Mass Spectrometry Level 2,,
Expand Down
255 changes: 236 additions & 19 deletions HTAN.model.jsonld
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39435,7 +39435,7 @@
{
"@id": "bts:SlideID",
"@type": "rdfs:Class",
"rdfs:comment": "The unique identifier printed on the label of each Visium slide. The serial number starts with V followed by a number which can range between one through five and ends with a dash and a three digit number, such as 123.",
"rdfs:comment": "For Visium, it is the unique identifier printed on the label of each Visium slide. The serial number starts with V followed by a number which can range between one through five and ends with a dash and a three digit number, such as 123. For CosMx, this refers to the loaded Flow Cell ID. For Xenium, this ID indicates the slide orientation, as it matches the relative location of the ID on the physical Xenium slide.",
"rdfs:label": "SlideID",
"rdfs:subClassOf": [
{
Expand Down Expand Up @@ -41706,7 +41706,7 @@
{
"@id": "bts:Surfacearea",
"@type": "rdfs:Class",
"rdfs:comment": "Surface area of the ROI in square microns (µm2)",
"rdfs:comment": "Surface area of the ROI in square microns (µm^2). In CosMx, this is referred to as the Scan Area. In Xenium, this is referred to as the Region Area",
"rdfs:label": "Surfacearea",
"rdfs:subClassOf": [
{
Expand Down Expand Up @@ -43996,6 +43996,240 @@
"sms:required": "sms:false",
"sms:validationRules": []
},
{
"@id": "bts:NanostringCosMxSMIExperiment",
"@type": "rdfs:Class",
"rdfs:comment": "RNA and Protein Panel assays applied as part of Nanostring CosMx Spatial Molecular Imager (SMI)",
"rdfs:label": "NanostringCosMxSMIExperiment",
"rdfs:subClassOf": [
{
"@id": "bts:SpatialTranscriptomics"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "Nanostring CosMx SMI Experiment",
"sms:required": "sms:false",
"sms:requiresComponent": [
{
"@id": "bts:Biospecimen"
}
],
"sms:requiresDependency": [
{
"@id": "bts:Component"
},
{
"@id": "bts:Filename"
},
{
"@id": "bts:FileFormat"
},
{
"@id": "bts:HTANParentBiospecimenID"
},
{
"@id": "bts:HTANDataFileID"
},
{
"@id": "bts:CosMxBundleContents"
},
{
"@id": "bts:SlideID"
},
{
"@id": "bts:CosMxAssayType"
},
{
"@id": "bts:PanelName"
},
{
"@id": "bts:ProtocolLink"
},
{
"@id": "bts:SoftwareandVersion"
},
{
"@id": "bts:TotalNumberofCells"
},
{
"@id": "bts:TotalNumberofTargets"
},
{
"@id": "bts:NumberofFOVs"
},
{
"@id": "bts:Surfacearea"
},
{
"@id": "bts:ExperimentIFChannels"
},
{
"@id": "bts:TranscriptsperCell"
},
{
"@id": "bts:PercentofTranscriptswithinCells"
},
{
"@id": "bts:MeanTotalTranscriptsperArea"
},
{
"@id": "bts:UniqueGenes"
},
{
"@id": "bts:TotalNegativeProbeCounts"
}
],
"sms:validationRules": []
},
{
"@id": "bts:CosMxBundleContents",
"@type": "rdfs:Class",
"rdfs:comment": "A comma separated list of filenames within the CosMx bundle zip file",
"rdfs:label": "CosMxBundleContents",
"rdfs:subClassOf": [
{
"@id": "bts:SpatialTranscriptomics"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "CosMx Bundle Contents",
"sms:required": "sms:true",
"sms:validationRules": []
},
{
"@id": "bts:CosMxAssayType",
"@type": "rdfs:Class",
"rdfs:comment": "The specification for barcodes on each image. Either RNA probe or protein antibody according to the assay",
"rdfs:label": "CosMxAssayType",
"rdfs:subClassOf": [
{
"@id": "bts:SpatialTranscriptomics"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"schema:rangeIncludes": [
{
"@id": "bts:RNA"
},
{
"@id": "bts:Protein"
}
],
"sms:displayName": "CosMx Assay Type",
"sms:required": "sms:true",
"sms:validationRules": []
},
{
"@id": "bts:NumberofFOVs",
"@type": "rdfs:Class",
"rdfs:comment": "The total number of FOVs recorded for the sample on a single flow cell",
"rdfs:label": "NumberofFOVs",
"rdfs:subClassOf": [
{
"@id": "bts:SpatialTranscriptomics"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "Number of FOVs",
"sms:required": "sms:true",
"sms:validationRules": []
},
{
"@id": "bts:MeanTotalTranscriptsperArea",
"@type": "rdfs:Class",
"rdfs:comment": "The mean total transcripts per um3",
"rdfs:label": "MeanTotalTranscriptsperArea",
"rdfs:subClassOf": [
{
"@id": "bts:SpatialTranscriptomics"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "Mean Total Transcripts per Area",
"sms:required": "sms:true",
"sms:validationRules": []
},
{
"@id": "bts:UniqueGenes",
"@type": "rdfs:Class",
"rdfs:comment": "The total unique genes detected above background",
"rdfs:label": "UniqueGenes",
"rdfs:subClassOf": [
{
"@id": "bts:SpatialTranscriptomics"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "Unique Genes",
"sms:required": "sms:false",
"sms:validationRules": []
},
{
"@id": "bts:TotalNegativeProbeCounts",
"@type": "rdfs:Class",
"rdfs:comment": "Mean Total Negative probe counts/cell",
"rdfs:label": "TotalNegativeProbeCounts",
"rdfs:subClassOf": [
{
"@id": "bts:SpatialTranscriptomics"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "Total Negative Probe Counts",
"sms:required": "sms:true",
"sms:validationRules": []
},
{
"@id": "bts:RNA",
"@type": "rdfs:Class",
"rdfs:comment": "TBD",
"rdfs:label": "RNA",
"rdfs:subClassOf": [
{
"@id": "bts:CosMxAssayType"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "RNA",
"sms:required": "sms:false",
"sms:validationRules": []
},
{
"@id": "bts:Protein",
"@type": "rdfs:Class",
"rdfs:comment": "TBD",
"rdfs:label": "Protein",
"rdfs:subClassOf": [
{
"@id": "bts:CosMxAssayType"
},
{
"@id": "bts:AnalyteType"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "protein",
"sms:required": "sms:false",
"sms:validationRules": []
},
{
"@id": "bts:MassSpectrometryLevel1",
"@type": "rdfs:Class",
Expand Down Expand Up @@ -55837,23 +56071,6 @@
"sms:required": "sms:false",
"sms:validationRules": []
},
{
"@id": "bts:Protein",
"@type": "rdfs:Class",
"rdfs:comment": "TBD",
"rdfs:label": "Protein",
"rdfs:subClassOf": [
{
"@id": "bts:AnalyteType"
}
],
"schema:isPartOf": {
"@id": "http://schema.biothings.io"
},
"sms:displayName": "protein",
"sms:required": "sms:false",
"sms:validationRules": []
},
{
"@id": "bts:Metabolite",
"@type": "rdfs:Class",
Expand Down

0 comments on commit ed898f6

Please sign in to comment.