Spatial Transcriptomics
Visium (with probes)
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.
REQUIRED - For this assay, you must also prepare and submit two additional metadata.tsv files following the metadata schemas linked here for RNAseq (with probes) and Histology. This link lists the set of fields that are required in the OME TIFF file XML header.
Metadata schema
Directory schemas
| pattern | required? | description |
|---|---|---|
extras\/.* |
âś“ | Folder for general lab-specific files related to the dataset |
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\/.* |
âś“ | All raw data files for the experiment. |
raw\/[^\/]+\.gpr |
✓ | This is a 10X Genomics layout file that’s generated by 10X and individualized for each Visium slide. This is a text file and can be generated using this 10X web form https://support.10xgenomics.com/spatial-gene-expression/software/pipelines/latest/using/slidefile-download along with the unique 10X Visium slide ID. |
raw\/additional_panels_used\.csv |
 | If multiple commercial probe panels were used, then the primary probe panel should be selected in the “oligo_probe_panel” metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. |
raw\/custom_probe_set\.csv |
 | This file should contain any custom probes used and must be included if the metadata field “is_custom_probes_used” is “Yes”. The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file). |
raw\/fastq\/.* |
âś“ | Raw sequencing files for the experiment |
raw\/fastq\/oligo\/.* |
âś“ | Directory containing fastq files pertaining to oligo sequencing. |
raw\/fastq\/oligo\/[^\/]+_R[^\/]+\.fastq\.gz |
âś“ | This is a gzip version of the fastq file. This file contains the cell barcode and unique molecular identifier (technical). |
raw\/images\/.* |
âś“ | Directory containing raw image files. This directory should include at least one raw file. |
raw\/images\/[^\/]+_tissue\.(?:tif|tiff) |
 | Raw microscope file for the experiment. For 10X Visium CytAssist, this would be the high resolution image produced. |
raw\/images\/[^\/]+_fiducial\.(?:tif|tiff) |
âś“ | This is the low resolution image from the 10X CytAssist instrument that includes the fiduciary markings. |
raw\/images\/[^\/]+\.ndpi |
 | Raw microscope file for the experiment |
lab_processed\/.* |
âś“ | Experiment files that were processed by the lab generating the data. |
lab_processed\/alignment\.json |
âś“ | JSON file for the manual tissue alignment created using Loupe browser and used as input to Space Ranger. |
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. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. 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). |
| pattern | required? | description |
|---|---|---|
extras\/.* |
âś“ | Folder for general lab-specific files related to the dataset |
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\/.* |
âś“ | All raw data files for the experiment. |
raw\/[^\/]+\.gpr |
✓ | This is a 10X Genomics layout file that’s generated by 10X and individualized for each Visium slide. This is a text file and can be generated using this 10X web form https://support.10xgenomics.com/spatial-gene-expression/software/pipelines/latest/using/slidefile-download along with the unique 10X Visium slide ID. |
raw\/additional_panels_used\.csv |
 | If multiple commercial probe panels were used, then the primary probe panel should be selected in the “oligo_probe_panel” metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. |
raw\/custom_probe_set\.csv |
 | This file should contain any custom probes used and must be included if the metadata field “is_custom_probes_used” is “Yes”. The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file). |
raw\/fastq\/.* |
âś“ | Raw sequencing files for the experiment |
raw\/fastq\/oligo\/.* |
âś“ | Directory containing fastq files pertaining to oligo sequencing. |
raw\/fastq\/oligo\/[^\/]+\.fastq\.gz |
âś“ | This is a gzip version of the fastq file. This file contains the cell barcode and unique molecular identifier (technical). |
raw\/images\/.* |
âś“ | Directory containing raw image files. This directory should include at least one raw file. |
raw\/images\/[^\/]+_tissue\.(?:tif|tiff) |
 | Raw microscope file for the experiment. For 10X Visium CytAssist, this would be the high resolution image produced. |
raw\/images\/[^\/]+_fiducial\.(?:tif|tiff) |
âś“ | This is the low resolution image from the 10X CytAssist instrument that includes the fiduciary markings. |
raw\/images\/[^\/]+\.ndpi |
 | Raw microscope file for the experiment |
lab_processed\/.* |
âś“ | Experiment files that were processed by the lab generating the data. |
lab_processed\/alignment\.json |
âś“ | JSON file for the manual tissue alignment created using Loupe browser and used as input to Space Ranger. |
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. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. 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 |
| pattern | required? | description |
|---|---|---|
extras\/.* |
âś“ | Folder for general lab-specific files related to the dataset |
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\/.* |
âś“ | All raw data files for the experiment. |
raw\/[^\/]+\.gpr |
✓ | This is a 10X Genomics layout file that’s generated by 10X and individualized for each Visium slide. This is a text file and can be generated using this 10X web form https://support.10xgenomics.com/spatial-gene-expression/software/pipelines/latest/using/slidefile-download along with the unique 10X Visium slide ID. |
raw\/additional_panels_used\.csv |
 | If multiple commercial probe panels were used, then the primary probe panel should be selected in the “oligo_probe_panel” metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. |
raw\/custom_probe_set\.csv |
 | This file should contain any custom probes used and must be included if the metadata field “is_custom_probes_used” is “Yes”. The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file). |
raw\/fastq\/.* |
âś“ | Raw sequencing files for the experiment |
raw\/fastq\/oligo\/ |
âś“ | Directory containing fastq files pertaining to oligo sequencing. |
raw\/fastq\/oligo\/[^\/]+\.fastq\.gz |
âś“ | This is a gzip version of the fastq file. This file contains the cell barcode and unique molecular identifier (technical). |
raw\/images\/.* |
âś“ | Directory containing raw image files. This directory should include at least one raw file. |
raw\/images\/[^\/]+_tissue\.(?:tif|tiff) |
 | Raw microscope file for the experiment. For 10X Visium CytAssist, this would be the high resolution image produced. |
raw\/images\/[^\/]+_fiducial\.(?:tif|tiff) |
âś“ | This is the low resolution image from the 10X CytAssist instrument that includes the fiduciary markings. |
raw\/images\/[^\/]+\.ndpi |
 | Raw microscope file for the experiment |
lab_processed\/.* |
âś“ | Experiment files that were processed by the lab generating the data. |
lab_processed\/alignment\.json |
âś“ | JSON file for the manual tissue alignment created using Loupe browser and used as input to Space Ranger. |
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. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. 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 |
| pattern | required? | description |
|---|---|---|
extras\/.* |
âś“ | Folder for general lab-specific files related to the dataset |
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\/.* |
âś“ | All raw data files for the experiment. |
raw\/[^\/]+\.gpr |
✓ | This is a 10X Genomics layout file that’s generated by 10X and individualized for each Visium slide. This is a text file and can be generated using this 10X web form https://support.10xgenomics.com/spatial-gene-expression/software/pipelines/latest/using/slidefile-download along with the unique 10X Visium slide ID. |
raw\/additional_panels_used\.csv |
 | If multiple commercial probe panels were used, then the primary probe panel should be selected in the “oligo_probe_panel” metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. |
raw\/custom_probe_set\.csv |
 | This file should contain any custom probes used and must be included if the metadata field “is_custom_probes_used” is “Yes”. The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file). |
raw\/fastq\/.* |
âś“ | Raw sequencing files for the experiment |
raw\/fastq\/oligo\/ |
âś“ | Directory containing fastq files pertaining to oligo sequencing. |
raw\/fastq\/oligo\/[^\/]+\.fastq\.gz |
âś“ | This is a gzip version of the fastq file. This file contains the cell barcode and unique molecular identifier (technical). |
raw\/images\/.* |
âś“ | Directory containing raw image files. This directory should include at least one raw file. |
raw\/images\/[^\/]+_tissue\.(?:tif|tiff) |
 | Raw microscope file for the experiment. For 10X Visium CytAssist, this would be the high resolution image produced. |
raw\/images\/[^\/]+_fiducial\.(?:tif|tiff) |
âś“ | This is the low resolution image from the 10X CytAssist instrument that includes the fiduciary markings. |
raw\/images\/[^\/]+\.ndpi |
 | Raw microscope file for the experiment |
lab_processed\/.* |
âś“ | Experiment files that were processed by the lab generating the data. |
lab_processed\/alignment\.json |
âś“ | JSON file for the manual tissue alignment created using Loupe browser and used as input to Space Ranger. |
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. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. 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\/images\/[^\/]+\.json |
 | This file is the output from LoupeBrowser, when a data provider manually denotes which spots on the slide contain tissue. This file is optionally used by 10X SpaceRanger. |
| pattern | required? | description |
|---|---|---|
extras\/.* |
âś“ | Folder for general lab-specific files related to the dataset |
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\/.* |
âś“ | All raw data files for the experiment. |
raw\/[^\/]+\.gpr |
✓ | This is a 10X Genomics layout file that’s generated by 10X and individualized for each Visium slide. This is a text file and can be generated using this 10X web form https://support.10xgenomics.com/spatial-gene-expression/software/pipelines/latest/using/slidefile-download along with the unique 10X Visium slide ID. |
raw\/additional_panels_used\.csv |
 | If multiple commercial probe panels were used, then the primary probe panel should be selected in the “oligo_probe_panel” metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. |
raw\/custom_probe_set\.csv |
 | This file should contain any custom probes used and must be included if the metadata field “is_custom_probes_used” is “Yes”. The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file). |
raw\/fastq\/.* |
âś“ | Raw sequencing files for the experiment |
raw\/fastq\/oligo\/ |
âś“ | Directory containing fastq files pertaining to oligo sequencing. |
raw\/fastq\/oligo\/[^\/]+\.fastq\.gz |
âś“ | This is a gzip version of the fastq file. This file contains the cell barcode and unique molecular identifier (technical). |
raw\/images\/.* |
âś“ | Directory containing raw image files. This directory should include at least one raw file. |
raw\/images\/[^\/]+_tissue\.(?:tif|tiff) |
 | Raw microscope file for the experiment. For 10X Visium CytAssist, this would be the high resolution image produced. |
raw\/images\/[^\/]+_fiducial\.(?:tif|tiff) |
âś“ | This is the low resolution image from the 10X CytAssist instrument that includes the fiduciary markings. |
raw\/images\/[^\/]+\.ndpi |
 | 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. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. 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\/images\/[^\/]+\.json |
 | This file is the output from LoupeBrowser, when a data provider manually denotes which spots on the slide contain tissue. This file is optionally used by 10X SpaceRanger. |
| pattern | required? | description |
|---|---|---|
extras\/.* |
âś“ | Folder for general lab-specific files related to the dataset |
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\/.* |
âś“ | All raw data files for the experiment. |
raw\/[^\/]+\.gpr |
✓ | This is a 10X Genomics layout file that’s generated by 10X and individualized for each Visium slide. This is a text file and can be generated using this 10X web form https://support.10xgenomics.com/spatial-gene-expression/software/pipelines/latest/using/slidefile-download along with the unique 10X Visium slide ID. |
raw\/additional_panels_used\.csv |
 | If multiple commercial probe panels were used, then the primary probe panel should be selected in the “oligo_probe_panel” metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. |
raw\/custom_probe_set\.csv |
 | This file should contain any custom probes used and must be included if the metadata field “is_custom_probes_used” is “Yes”. The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file). |
raw\/fastq\/.* |
âś“ | Raw sequencing files for the experiment |
raw\/fastq\/oligo\/.* |
âś“ | Directory containing fastq files pertaining to oligo sequencing. |
raw\/fastq\/oligo\/[^\/]+\.fastq\.gz |
âś“ | This is a gzip version of the fastq file. This file contains the cell barcode and unique molecular identifier (technical). |
raw\/images\/.* |
âś“ | Directory containing raw image files. This directory should include at least one raw file. |
raw\/images\/[^\/]+_tissue\.(?:tif|tiff) |
 | Raw microscope file for the experiment. For 10X Visium CytAssist, this would be the high resolution image produced. |
raw\/images\/[^\/]+_fiducial\.(?:tif|tiff) |
âś“ | This is the low resolution image from the 10X CytAssist instrument that includes the fiduciary markings. |
raw\/images\/[^\/]+\.ndpi |
 | 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. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. 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 |