Skip to main content

Spatial Transcriptomics (ST) Pipeline

License: MIT Python 3.10 Python 3.11 Python 3.12 PyPI version Build Status

The ST Pipeline provides the tools, algorithms and scripts needed to process and analyze the raw data generated with Spatial Transcriptomics or Visium in FASTQ format to generate datasets for down-stream analysis.

The ST Pipeline can also be used to process single cell/nuclei RNA-seq data as long as a file with molecular barcodes identifying each cell is provided (same template as the files in the folder "ids").

The ST Pipeline can also be used to process bulk RNA-seq data, in this case the barcodes file is not required.

The ST Pipeline has been optimized for speed, robustness and it is very easy to use with many parameters to adjust all the settings. The ST Pipeline is fully parallel and it has constant memory use. The ST Pipeline allows to skip any of the main steps and provides multiple customization options. The ST Pipeline allows to use either the genome or the transcriptome as reference.

Basically what the ST pipeline does (default mode) is:

  • Quality trimming step (read 1 and read 2):
    • Remove low quality bases
    • Sanity check (reads same length, reads order, etc..)
    • Check quality UMI
    • Remove artifacts (PolyT, PolyA, PolyG, PolyN and PolyC) of user defined length
    • Check for AT and GC content
    • Discard reads with a minimum number of bases of that failed any of the checks above
  • Contamimant filter step (e.x. rRNA genome) (Optional)
  • Mapping with STAR step (only read 2) (Optional)
  • Demultiplexing with Taggd step (only read 1) (Optional)
  • Keep reads (read 2) that contain a valid barcode and are correctly mapped
  • Annotate the reads to the reference (Optional)
  • Group annotated reads by barcode (spot position), gene and genomic location (with an offset) to get a read count
  • In the grouping/counting only unique molecules (UMIs) are kept (Optional)

You can see a graphical more detailed description of the workflow in the documents workflow.pdf and workflow_extended.pdf

The output dataset is a matrix of counts (genes as columns, spots as rows) in TSV format. The ST pipeline will also output a log file with useful stats and information.

Installation

For users see install

For developers contributing

Usage

See usage

Authors

See authors

License

The ST pipeline is open source under the MIT license which means that you can use it, change it and re-distribute but you must always refer to our license (see LICENSE).

Credits

If you use the ST Pipeline, please refer its publication: ST Pipeline: An automated pipeline for spatial mapping of unique transcripts Oxford BioInformatics 10.1093/bioinformatics/btx211

Example dataset

You can see a real dataset obtained from the public data from the following publication (http://science.sciencemag.org/content/353/6294/78) in the folder called "data".

Contact

For questions, bugs, feedback, etc.. you can contact:

Jose Fernandez Navarro jc.fernandez.navarro@gmail.com

Metadata

Release files for stpipeline 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stpipeline 2.1.0
File Size Uploaded Provenance
stpipeline-2.1.0.tar.gz 46.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for stpipeline 2.1.0
File Interpreter ABI Platform
stpipeline-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 104.1 kB

Release files / stpipeline-2.1.0.tar.gz

Download URL stpipeline-2.1.0.tar.gz
Size 46.7 kB
Tags Source
SHA-256 checksum
How to use checksums
348edb926ee47bb1fee3fb769662fca0236436cde6829f4514413eac465a22f5
BLAKE2b-256 checksum
How to use checksums
194b3ac7ed9ba9f53389fb87168d2c48059dc00a4df3ab0f439bf6955f555fe7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.10.12 Darwin/25.2.0

Release files / stpipeline-2.1.0-py3-none-any.whl

Download URL stpipeline-2.1.0-py3-none-any.whl
Size 57.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
10fb169c6547c9e072daaad1c58cbc8d941a252aa9451aa2a70bee920fd12bc4
BLAKE2b-256 checksum
How to use checksums
ac20f3af1bb9b37efdcb84280db1052b610038733547c62a43a57864be46fa25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.10.12 Darwin/25.2.0

Security for stpipeline 2.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page