Metadata File Annotation Template
A template outlining metadata to be collected for annotating metadata files.
Instructions
This template collects file-level metadata and curates your file with this critical information thereby enabling discoverability, SQL queries, and overall organization and metrics calculations of your data files.
| Attribute | Description | Required | Valid Values |
|---|---|---|---|
| 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'. Multiple selections can be provided in a comma-delimited list. | TRUE | ASAPSeq, ATACSeq, CE-MS, CITESeq, CosMX, CyTOF, GenePS SeqFISH, H&E, LC-MS/MS, NULISA, Not Applicable, Olink Explore HT, Olink Flex, Olink Focus, Olink Reveal, Olink Target 48, Olink Target 96, RNASeq, SNP array, SomaScan, VDJSeq, Visium, WES, WGS, Xenium, feature barcode sequencing, flow cytometry, imaging mass cytometry, imaging mass spectrometry, kiloplex, multiplexed ELISA, scRNASeq, scVDJSeq, serial IHC, snATACSeq, snRNASeq |
| fileFormat | Standard file format name or file extension | TRUE | bai, bam, bed, bim, csv, czi, docx, dose, erate, fam, fastq, fcs, geojson, h5, h5ad, html, info, mcd, mtx, parquet, pdf, py, rds, rec, svs, tbi, tgz, tsv, txt, vcf, xls, xlsx, zip |
| metadataStandards | Metadata standards used to generate the metadata | TRUE | ARK data model, user-defined |
| metadataType | A label further classifying the content of metadata resource. If a metadata file contains multiple types please specify all that apply in a comma-delimited list | TRUE | demographics, clinical, assay, biospecimen, cell coordinates, data dictionary, file manifest, medication, other, phenotype, protocol, single-cell metadata, target panel, template, tissue microarray map, user manual, alignment metrics |
| program | Name of the funding program that supported the generation of data and associated files | TRUE | AMP AIM, AMP RA/SLE, Community Contribution |
| programPhase | A label noting which AMP RA/SLE program phase generated the data. Multiple selections can be provided in a comma-delimited list. | TRUE | I, II |
| project | A sub-level attribute of `program` specifying a research initiative working to investigate particular hypotheses. Multiple selections can be provided in a comma-delimited list. | TRUE | AIM for RA, EDP1, EDP2, ELLIPSS, LOCKIT, METRO, NRP1, NRP2, RA, SLE, STAMP, UMass V-CoRT |
| resourceType | High-level classification of the file content | TRUE | code, experimental data, figure, metadata |