MACSima Metadata Attributes

Fields that are collected for MACSima data, available at dataset.metadata.<attribute>  

* indicates a required field

Attribute Type Description Allowable Values
parent_sample_id * The unique identifier from HuBMAP or SenNet for the sample (such as a block, section, or suspension) used to perform the assay. For instance, in an RNAseq assay, the parent sample would be the suspension, while in imaging assays, it would be the tissue section. If the assay is derived from multiple parent samples, this field should contain a comma-separated list of identifiers. Example: HBM386.ZGKG.235, HBM672.MKPK.442  
lab_id A locally assigned identifier provided by the data provider for the dataset. It is used to reference an external metadata record that may be maintained independently, enabling traceability and supporting provenance tracking. Example: Visium_9OLC_A4_S1  
preparation_protocol_doi * The DOI for the protocols.io page that details the assay or the procedures used for sample procurement and preparation. For example, in the case of an imaging assay, the protocol may start with tissue section staining and end with the generation of an OME-TIFF file. The documented protocol should also include any image processing steps involved in producing the final OME-TIFF. Example: https://dx.doi.org/10.17504/protocols.io.eq2lyno9qvx9/v1  
dataset_type * The specific type of dataset being produced. Example: RNAseq 10X Multiome 2D Imaging Mass Cytometry 4i ATACseq Auto-fluorescence Cell DIVE CODEX COMET Confocal CosMx Proteomics CosMx Transcriptomics CyCIF CyTOF DART-FISH DBiT-seq DESI DNA Methylation Enhanced Stimulated Raman Spectroscopy (SRS) FACS GeoMx (nCounter) GeoMx (NGS) HiFi-Slide Histology iCLAP Illumina Spatial ver0 LC-MS Light Sheet MACSima MALDI MERFISH MIBI Molecular Cartography MPLEx MS Lipidomics MUSIC nanoSPLITS Olink PhenoCycler Pixel-seqV2 Raman Imaging Resolve RNAseq RNAseq (with probes) Second Harmonic Generation (SHG) Seq-Scope seqFISH SIMS Singular Genomics G4X SNARE-seq2 STARmap Stereo-seq Thick section Multiphoton MxIF Virtual Histology Visium (no probes) Visium (with probes) Visium HD Xenium
analyte_class * The analyte class which is the target molecule that the assay is measuring. Example: DNA Chromatin Collagen DNA DNA + RNA Endogenous fluorophore Fluorochrome Lipid Lipid + metabolite Lipid + metabolite + protein Metabolite Nucleic acid + protein Peptide Polysaccharide Protein RNA RNA + protein Saturated lipid Unsaturated lipid
is_targeted * Indicates whether a specific molecule or set of molecules is targeted for detection or measurement by the assay. Example: Yes Yes No
acquisition_instrument_vendor * The company that manufactures or supplies the acquisition instrument. An acquisition instrument is a device equipped with signal detection hardware and signal processing software. It captures signals produced by assays, such as variations in light intensity or color, or signals corresponding to molecular mass. If the instrument was custom-built or developed internally, enter “In-House”. Example: Illumina 10x Genomics 3DHISTECH Akoya Biosciences Andor BGI Genomics Bruker Complete Genomics Cytek Biosciences Cytiva Element Biosciences Evident Scientific (Olympus) GE Healthcare Hamamatsu Huron Digital Pathology Illumina In-House Ionpath Keyence Leica Biosystems Leica Microsystems Microscopes International Miltenyi Biotec Motic NanoString Resolve Biosciences Revvity Sciex Singular Genomics Standard BioTools (Fluidigm) Thermo Fisher Scientific Vizgen Waters Zeiss Microscopy
acquisition_instrument_model * The specific model of the acquisition instrument, as manufacturers often offer various versions with differing features or sensitivities. These differences may be relevant to the processing or interpretation of the data. If the instrument was custom-built or developed internally, enter “In-House”. If the model is unknown, enter “Unknown”. Example: HiSeq 4000 Aperio AT2 Aperio CS2 AVITI Axio Observer 3 Axio Observer 5 Axio Observer 7 Axio Scan.Z1 Axio Zoom.V16 Biomark HD BZ-X710 BZ-X800 BZ-X810 Cell DIVE CosMx Spatial Molecular Imager Custom: Multiphoton Cytek Northern Lights CyTOF 2 CyTOF XT Digital Spatial Profiler DM6 B DMi8 DNBSEQ-T7 EVOS M7000 G4X Spatial Sequencer Helios HiSeq 2500 HiSeq 4000 Hyperion Imaging System IN Cell Analyzer 2200 In-House Juno System Lightsheet 7 LSM 710 Confocal Microscope MACSima System MALDI timsTOF Flex Prototype MERSCOPE MERSCOPE Ultra MIBIscope MoticEasyScan One NanoZoomer 2.0-HT NanoZoomer 2.0-RS NanoZoomer S210 NanoZoomer S360 NanoZoomer S60 NanoZoomer-SQ NextSeq 2000 NextSeq 500 NextSeq 550 Not applicable NovaSeq 6000 NovaSeq X NovaSeq X Plus Opera Phenix HCS Opera Phenix Plus HCS Orbitrap Eclipse Tribrid Orbitrap Fusion Lumos Tribrid Orbitrap Fusion Tribrid Pannoramic MIDI II Digital Scanner Panoramic 150 Digital Scanner Phenocycler-Fusion 1.0 Phenocycler-Fusion 2.0 PhenoImager Fusion Q Exactive Q Exactive HF Q Exactive HF-X Q Exactive UHMR QTRAP 5500 Resolve Biosciences Molecular Cartography SCN400 solariX STELLARIS 5 SYNAPT G2-Si timsTOF FleX timsTOF FleX MALDI-2 timsTOF HT timsTOF Pro timsTOF Pro 2 timsTOF SCP timsTOF Ultra timsTOF Ultra 2 TissueScope LE Slide Scanner Unknown uScopeHXII-20 VS200 Slide Scanner Xenium Analyzer Zeiss LightSheet Z.1 Zyla 4.2 sCMOS
source_storage_duration_value * The length of time the sample was stored prior to processing it. For assays performed on tissue sections, this refers to how long the tissue section (e.g., slide) was stored before the assay began (e.g., imaging). For assays performed on suspensions, such as sequencing, it refers to how long the suspension was stored before library construction started. Example: 12  
source_storage_duration_unit * The unit of measurement used to specify the source storage duration value. Example: hour day hour minute month year
time_since_acquisition_instrument_calibration_value The length of time since the acquisition instrument was last serviced or calibrated. This provides a metric for assessing drift in data capture. Example: 10  
time_since_acquisition_instrument_calibration_unit The unit of measurement used to specify the time since acquisition instrument calibration value. Example: month day month year
contributors_path * The name of the file containing the ORCID IDs for all contributors to this dataset. Example: ./contributors.csv  
data_path * The top-level directory containing the raw and/or processed data. For a single dataset upload, this might be represented as “.”, whereas for a data upload containing multiple datasets, this would be the directory name for the respective dataset. For example, if the data is within a directory named “TEST001-RK”, use the syntax “./TEST001-RK” for this field. If there are multiple directory levels, use the format “./TEST001-RK/Run1/Pass2”, where “Pass2” is the subdirectory where the single dataset’s data is stored. This is an internal metadata field used solely for data ingestion. Example: ./TEST001-RK  
antibodies_path * The path to the antibodies.tsv file relative to the root directory of the upload structure. This path should start with “.” and is typically formatted as “./extras/antibodies.tsv”. Example: ./extras/antibodies.tsv  
total_run_time_value * The total run time, which is the duration the instrument takes to fully complete all imaging rounds on the loaded slide. Example: 24  
total_run_time_unit * The unit of measurement for the total run time value. If the total run time is not specified, this field may be left blank. Example: hour hour minute
number_of_antibodies * The number of antibodies used in the assay. If no antibodies were utilized, enter 0. Example: 5  
number_of_channels * The number of fluorescent channels that are imaged during each cycle. Example: 3  
number_of_biomarker_imaging_rounds * The number of imaging rounds required to capture the tagged biomarkers. For CODEX, a biomarker imaging round includes steps such as (1) oligo application, (2) fluor application, and (3) washes. For Cell DIVE, it involves (1) the staining of a biomarker via secondary detection or direct conjugate, followed by (2) dye inactivation. Example: 3  
number_of_total_imaging_rounds * The total number of imaging rounds performed using a microscope to collect either autofluorescence/background or stained signals, such as those used in histological analysis. Example: 5  
slide_id The unique identifier assigned to each slide, enabling users to determine which tissue sections were processed together on the same slide. It is recommended that data providers prefix the ID with the center name to prevent overlapping values across different centers. Example: VAN0071-PA-1-1_AF  
cell_boundary_marker_or_stain * The name of the marker or stain used to identify all cell boundaries in the tissue. This name must exactly match the antibody-targeted molecule marker or non-antibody targeted molecule stain as found in the imaging data. For example, in the case of using the PhenoCycler, ensure the name corresponds to the value in the XPD output file. If multiple markers or stains are employed, list them in a comma-separated format. Example: Pan-Cytokeratin, E-Cadherin  
nuclear_marker_or_stain * The nuclear marker or stain used, which can be an antibody-targeted molecule present in or around the cell nucleus. For protein targets, use the protein or gene symbol that identifies the antibody target, ensuring it matches the antibody target from the panel used or custom panels. Preferably, if using a custom antibody marker, this symbol should be the HGNC symbol (https://www.genenames.org/). For non-protein targets, provide the stain name (e.g., DAPI) and, when applicable, include the associated staining kit and vendor. For the PhenoCycler, ensure the symbol matches the value found in the XPD output file. Example: DAPI  
non_global_files Specifies a semicolon-separated list of non-global files that are to be included in the dataset. The file paths assume that the files are located in the “TOP/non-global/” directory. For instance, if the file is located at TOP/non-global/lab_processed/images/1-tissue-boundary.geojson, the value for this field would be “./lab_processed/images/1-tissue-boundary.geojson”. Once ingested, these files will be copied to their appropriate locations within the respective dataset directory tree. This field is intended for internal HuBMAP processing. Examples for GeoMx and PhenoCycler are provided in the File Locations documentation: https://docs.google.com/document/d/1n2McSs9geA9Eli4QWQaB3c9R3wo5d5U1Xd57DWQfN5Q/edit#heading=h.1u82i4axggee Example: ./lab_processed/images/1-tissue-boundary.geojson  
signal_quenching_method * An automated step in cyclic imaging workflows that removes fluorescent signals from a sample to enable subsequent rounds of staining. This process is critical for high-multiplex imaging, allowing the detection of numerous markers on a single sample while preserving tissue integrity, as demonstrated by technologies such as MACSima Imaging Cyclic Staining (MICS). Example: Photobleaching Enzymatic cleavage Photobleaching
metadata_schema_id * The unique string identifier for the metadata specification version, which is easily interpretable by computers for purposes of data validation and processing. Example: 22bc762a-5020-419d-b170-24253ed9e8d9