Metadata File Annotation Template
A template outlining metadata to be collected for annotating metadata files to be compiled by ARK BDM.
| Attribute | Description | Required | Valid Values |
|---|---|---|---|
| Component | A high-level attribute for grouping attributes into templates. | TRUE | |
| 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'. | TRUE | ASAPSeq, CE-MS, CITESeq, CosMX, CyTOF, GenePS SeqFISH, H&E, LC-MS/MS, NULISA, 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 |
| dataType | High-level classification of the type of data contained in the file, loosely related to the experimental method or biological entity that is being profiled. Select all that apply using a comma-delimited list, though in most cases only a single label is expected. For multimodal datasets with concomitant profiling of biospecimen include 'multimodal'. | TRUE | cytometry, epigenomics, genomics, histology, immune repertoire profiling, immunostaining, lipidomics, metabolomics, microbiome, multimodal, proteomics, transcriptomics |
| 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. | TRUE | I, II |
| project | A sub-level attribute of `program` specifying a research initiative working to investigate particular hypotheses. | TRUE | AIM for RA, EDP1, EDP2, ELLIPSS, LOCKIT, METRO, RA, SLE, STAMP, UMass V-CoRT |
| resourceType | High-level classification of the file content | TRUE | code, experimental data, figure, metadata |