Spatial Assay Metadata Template
A template outlining metadata to be collected for each slide in a spatial transcriptomic or imaging based dataset.
| Attribute | Description | Required | Valid Values |
|---|---|---|---|
| targetPanelSynID | In most cases an accompanying metadata file should be provided that details information about the targets profiled in the experiment. This attribute links experimental data files to the target panel metadata via the synapse ID of that file. | True | |
| specimenModality | Label assigned to experimental data files indicating whether the data contained corresponds to a single or multiple biospecimens | True | multispecimen, single specimen |
| targetPanelSize | The number of gene, transcript, protein, etc., targets profiled in the assay for assays that use a pre-defined set of probes, antibodies, etc., to measure biological components in samples. The input value is expected to be a whole integer that matches the number of targets described in the accompanying target panel metadata (i.e., targetPanelSynID). | False | |
| Component | A high-level attribute for grouping attributes into templates. | True | |
| targetPanel | A unique or established human-readable name assigned to the panel of targets profiled in the experiment. For example, the panel of antibodies and corresponding fluorophores used in a flow cytometry experiment or panel used in a Xenium spatial transcriptomics experiment. | True | |
| sampleProcessingBatch | A label indicating batching of sample processing or preparation that occurs prior to data collection. | False | |
| assay | The technology used to generate the data in this file. For multimodal datasets with concomitant profiling of biospecimen select all assays that apply. e.g., the GEX files from a CITE-seq experiment should be labeled with both 'scRNASeq' and 'CITESeq'. | Xenium, CosMX, GenePS SeqFISH, imaging mass cytometry, Visium, H&E, serial IHC | |
| dataCollectionBatch | A label indicating batching that occurs during data collection, e.g., collecting data across multiple days. | False | |
| individualID | Unique identifier assigned to each study participant. For multi-specimen data files provide all IDs in a comma-separated list. | True | |
| biospecimenID | A unique identifier assigned to specimens collected from study participants. For multi-specimen data files provide all IDs in a comma-separated list. | True | |
| slideID | A library label or name, unique within an experiment, used to distinguish imaging slides. | True |