Prepare your metadata based on the latest metadata schema using one of the template files below. See the instructions in the Metadata Validation Workflow document for more information on preparing and validating your metadata.tsv file prior to submission.

Related files:

• 📝 Excel template: For metadata entry.
• 📝 TSV template: Alternative for metadata entry.

This link lists the set of fields that are required in the OME TIFF file XML header.

Metadata schema

Version 2 (use this one)

Directory schemas

Version 2.0 (use this one)

pattern	required?	description
extras\/.*	✓	Folder for general lab-specific files related to the dataset. [Exists in all assays]
extras\/microscope_hardware\.json	✓	[QA/QC] A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk help@hubmapconsortium.org if help is required in generating this document.
extras\/microscope_settings\.json		[QA/QC] A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk help@hubmapconsortium.org if help is required in generating this document.
raw\/.*	✓	Raw data files for the experiment.
raw\/channel_layout\.tsv	✓	Table that includes a dictionary for channel to moiety, which may be a protein given in an OMAP panel or captured in the ASCT+B table.
raw\/lightpath_configuration\.tsv		This file documents the light path setttings not captured in the OME-TIFF - will be deprecated upon the implementation of MicroMeta.
raw\/fingerprint_layout\.tsv		Table that includes a dictionary for channel to moiety which is determined from spectral clustering and may include lipids, protein, etc. This file is specific to hyper-spectral imaging.
raw\/images\/.*	✓	Raw image files. Using this subdirectory allows for harmonization with other imaging assays. [This directory must include at least one raw file.]
raw\/images\/[^\/]+\.(?:xml|nd2|oir|lif|czi|tiff)	✓	Raw microscope file for the experiment
lab_processed\/.*	✓	Experiment files that were processed by the lab generating the data.
lab_processed\/images\/.*	✓	Processed image files
lab_processed\/images\/[^\/]+\.ome\.tiff (example: lab_processed/images/HBM892.MDXS.293.ome.tiff)	✓	OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. https://docs.google.com/spreadsheets/d/1YnmdTAA0Z9MKN3OjR3Sca8pz-LNQll91wdQoRPSP6Q4/edit#gid=0
lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv	✓	This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed https://docs.google.com/spreadsheets/d/1xEJSb0xn5C5fB3k62pj1CyHNybpt4-YtvUs5SUMS44o/edit#gid=0
lab_processed\/transformations\/.*		This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
lab_processed\/transformations\/[^\/]+\.txt		Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
qa_qc\/.*	✓	Directory containing QA and/or QC information.
qa_qc\/resolution_report\/.*	✓	Directory containing the results of resolution tests and/or vendor preventative maintenance reports.
qa_qc\/resolution_report\/resolution\.txt		This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits.
qa_qc\/resolution_report\/[^\/]+\.pdf		This file is a pdf from a vendor preventative maintenance visit or resolution check tool demonstrating resolution. This file may include illumination test results.
qa_qc\/illumination_report\/.*	✓	Directory containing the results of illumination tests and/or vendor preventative maintenance reports.
qa_qc\/illumination_report\/illumination.txt		This file summarizes the results of illumination tests or vendor reports from preventative maintenance visits.
qa_qc\/illumination_report\/[^\/]+\.pdf		This file is a pdf from a vendor preventative maintenance visit or illumination check tool demonstrating illumination intensity.