Olink Assay Metadata Template
A template outlining assay metadata to be collected for each plate in an Olink dataset.
Instructions
The template collects assay-level metadata for your Olink data. Each row is expected to correspond to a single plate. plateID is expected to be unique within this template. The same plateID are expected to be used in corresponding File Annotation template.
| Attribute | Description | Required | Valid Values |
|---|---|---|---|
| assay | The technology used to generate the data in this file. | TRUE | Olink Explore HT, Olink Reveal, Olink Flex, Olink Focus, Olink Target 48, Olink Target 96 |
| 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 | |
| dataCollectionBatch | A label indicating batching that occurs during data collection, e.g., collecting data across multiple days. | FALSE | |
| plateID | An identifier, unique within a dataset, used to label a multi-well plate used for sample profiling. | TRUE | |
| platform | The specific version (manufacturer, model, etc.) of a technology that is used to carry out a laboratory or computational experiment. Specify where applicable for experimental data files, else enter 'none'. In most cases only a single label is expected, however multiple selections can be provided in comma-delimited list where applicable e.g., for 10x Genomics fastq files please specify both the 10x instrument and the sequencing platform. | TRUE | Olink Signature Q100, Fluidigm BioMark, Illumina NextSeq 500, Illumina NovaSeq 6000, unknown |
| 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 | |
| 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 | |
| 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 |