10x Genomics
Visium Spatial Gene Expression

Space Ranger1.1, printed on 11/22/2024

Understanding Output

The Space Ranger software strives to maintain compatibility with common analysis tools by using standard output file formats whenever possible. For example, the barcoded BAM files can be viewed in standard genome browsers such as IGV to verify alignment quality and other features. The Visium-specific data, including cellular and molecular barcodes, can be accessed via any third-party tools or scripts that can parse the additional elements utilized by Space Ranger.

All pipelines produce all of their output in a single pipeline output directory, whose name depends on the pipeline:

• For spaceranger mkfastq, the flowcell serial number is used (e.g., HAWT7ADXX)
• For spaceranger count, the --id argument is used
• For spaceranger aggr, the --id argument is used

Output files appear in the outs/ subdirectory within this pipeline output directory. For example, a typical spaceranger count looks similar to the following:

$ cd /home/jdoe/runs
$ spaceranger count --id=sample345 \
                 --fastqs=/home/jdoe/runs/HAWT7ADXX/outs/fastq_path \
                 --transcriptome=/opt/refdata-gex-GRCh38-2020-A \
                 --image=/home/jdoe/image.tif \
                 --slide=V19J01-123 --area=B1
 
Martian Runtime - 4.0.0
 
Running preflight checks (please wait)...
2019-01-01 10:23:52 [runtime] (ready)           ID.sample345.SPATIAL_RNA_COUNTER_CS.CLOUPE_TILE_IMAGES
...
2019-01-01 12:10:09 [runtime] (join_complete)   ID.sample345.SPATIAL_RNA_COUNTER_CS.CLOUPE_PREPROCESS
 
Outputs:
- Run summary HTML:                      /home/jdoe/runs/sample345/outs/web_summary.html
- Outputs of spatial pipeline:           /home/jdoe/runs/sample345/outs/spatial
- Run summary CSV:                       /home/jdoe/runs/sample345/outs/metrics_summary.csv
- BAM:                                   /home/jdoe/runs/sample345/outs/possorted_genome_bam.bam
- BAM index:                             /home/jdoe/runs/sample345/outs/possorted_genome_bam.bam.bai
- Filtered feature-barcode matrices MEX:    /home/jdoe/runs/sample345/outs/filtered_feature_bc_matrix
- Filtered feature-barcode matrices HDF5:   /home/jdoe/runs/sample345/outs/filtered_feature_bc_matrix.h5
- Unfiltered feature-barcode matrices MEX:  /home/jdoe/runs/sample345/outs/raw_feature_bc_matrix
- Unfiltered feature-barcode matrices HDF5: /home/jdoe/runs/sample345/outs/raw_feature_bc_matrix_h5.h5
- Secondary analysis output CSV:         /home/jdoe/runs/sample345/outs/analysis
- Per-molecule read information:         /home/jdoe/runs/sample345/outs/molecule_info.h5
- Loupe Browser file:               /home/jdoe/runs/sample345/outs/cloupe.cloupe
 
Pipestance completed successfully!

In this case:

• /home/jdoe/runs/ is where the pipeline was run.
• /home/jdoe/runs/sample345/ is the top-level output directory containing pipeline metadata.
• /home/jdoe/runs/sample345/outs/ contains the final pipeline output files.

The contents of this outs/ directory contain the data that is described in the remainder of this section: run summary HTML, run summary Images, run analysis, feature-barcode matrices MEX and HDF5, barcoded BAMs, and molecule info HDF5.

More information about the contents of the pipeline output directory can be found in the Pipestance Structure page.