Skip to main content

Single-cell Active Transcription Analysis

Project description

scATrans

PyPI version Python versions Documentation Status CI License

scATrans is a Python toolkit for single-cell differential analysis. It is primarily designed for datasets that contain spliced/unspliced (or mature/nascent) RNA layers. In this setting it computes a composite active transcription score that integrates differential expression with reference-based excess unspliced RNA to rank genes.

It also supports conventional differential expression workflows (no velocity data required) using scanpy, PyDESeq2 pseudobulk, linear mixed models, or optional Memento. Functional enrichment (ORA, GSEA, GO, KEGG) uses bundled gene sets with consistent universe handling, and a set of visualization functions is provided.

📚 Full documentation, tutorials, and the complete API reference are on Read the Docs: https://scatrans.readthedocs.io

Installation

pip install scatrans

# Optional extras: advanced (scVelo) mode, pseudobulk DE (PyDESeq2), Memento, GSEA
pip install "scatrans[advanced,gene_features,pseudobulk]" gseapy

See Installation for extras, source installs, and logging setup.

Quickstart

import scatrans as scat

# One-liner pipeline: score → filter → GO enrichment
result = scat.run_default_pipeline(
    adata,
    groupby="condition",
    target_group="Disease",
    reference_group="Control",
    sample_col="sample",   # optional; auto-selects pseudobulk when >=3 replicates/group
    organism="mouse",
)
print(result["candidates"].head())
print(result["enrichment"].head())

See the Quickstart for a complete end-to-end walkthrough, the Tutorials for fully worked, real-data notebooks (with and without RNA-velocity layers), and the User Guide for DE backends, enrichment, plotting, and advanced options.

Before reporting results in a paper

active_score is a composite heuristic rank, not a p-value or FDR on its own. See Statistical Guidance for what each output column means, safe vs. unsafe uses, and a reporting checklist before you cite scATrans results in a manuscript or supplement.

License

Software (Python source) is licensed under Apache License 2.0. Bundled gene-set data (GO, KEGG) carries its own licensing terms — see License before commercial use.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scatrans-0.9.9.tar.gz (14.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scatrans-0.9.9-py3-none-any.whl (9.0 MB view details)

Uploaded Python 3

File details

Details for the file scatrans-0.9.9.tar.gz.

File metadata

  • Download URL: scatrans-0.9.9.tar.gz
  • Upload date:
  • Size: 14.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for scatrans-0.9.9.tar.gz
Algorithm Hash digest
SHA256 17b2d20ae3ff20f739fcf1dbee227b8e46bbd717323a4eacbbcba84ac7a04240
MD5 0ce835b65384955bee8283b240d6fab4
BLAKE2b-256 df3067ecdb7125b3de8b5a55f817e06914728ea6d1edf651c200c85f4fb70375

See more details on using hashes here.

File details

Details for the file scatrans-0.9.9-py3-none-any.whl.

File metadata

  • Download URL: scatrans-0.9.9-py3-none-any.whl
  • Upload date:
  • Size: 9.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for scatrans-0.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 32b9f0b2e16993a5fe42ae3c34db30e72fb6812822aa236cae877a666088ad81
MD5 250d99115478f2e1cf7550af82b954da
BLAKE2b-256 975e8f008e1d51d367d025cfc11bf31a32da3a489fa4a466d6085a8412d259e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page