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.dev2.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.dev2-py3-none-any.whl (9.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scatrans-0.9.9.dev2.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.dev2.tar.gz
Algorithm Hash digest
SHA256 1bbc311cdd39b33d05d5e5de0e7912d9f8f8e9fde12a0ce4d008261d7699173f
MD5 9b24c7b6762cd187e08d0baf37bbd9f6
BLAKE2b-256 a33d0a077d6d48738a7c326cbaa4c54286178ff094e1c6db2a416a5f3372802d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scatrans-0.9.9.dev2-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.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 f8e98b548e1d89228c70a5d950ad3b8f7939443d1a4bc4be80c4df1ddc24181d
MD5 94316039b5faf5a5e94dcd5265a29914
BLAKE2b-256 f2165b5b510aed29d32c278b566dc51d5567080428bacb8bd39a20bcb18986e6

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