Skip to main content

sc-deg-explorer

A Plotly Dash web application for interactively exploring Differentially Expressed Genes (DEGs) from single-cell RNA sequencing experiments. Its reusable Dash components and plots are included in the ADEX package, which provides a configurable, dataset-agnostic interface that can be pointed at new datasets simply by swapping a JSON configuration file — no code changes required.


Table of Contents

  1. Purpose
  2. Expected inputs
  3. Example output
  4. Usage
  5. Configuration

Purpose

sc-deg-explorer is designed to make DEG results from single-cell pseudobulk analyses immediately accessible to wet-lab and computational scientists alike. After running a DESeq2-based differential expression pipeline, users can point this app at the output files and interactively:

  • Explore DEGs through interactive volcano plots, MA plots, and per-covariate DEG views.
  • Investigate gene expression for any selected gene using pseudo-bulk box plots stratified by donor, condition, or cell type.
  • Analyze pathway enrichment results via GSEA volcano plots and pathway selection dropdowns.
  • Filter by cell type and experimental covariates (e.g., day, treatment, cytokine) using sidebar dropdowns that dynamically update all plots.
  • Browse gene panels to quickly navigate to genes of interest.

The app is designed to be deployed as an internal data portal, enabling research teams to rapidly iterate on hypotheses without writing additional analysis code.


Expected inputs

The major inputs to the program are:

1. [Required]: Configuration file Manually fill the configuration file config/template.json with project-specific details.
2. [Required]: Differential results from tools like DESeq2 An example dataset can be found in the file input-data-examples/deseq2.xlsx. Make sure to format the data in csv.gz.
3. [Optional]: Enrichment results from GSEA An example dataset can be found in the file input-data-examples/fGSEA.xlsx. Make sure to format the data in tsv.gz.

Note on input data format: The overall intention of the input data format is to use a set of columns to specify important combinations of independent variables, which will demarcate several DE tests into one file. These covariate columns must be present and match across every input data type.

Note on specifying covariates: While there are instructions in the config file, this small piece of information is important to get right: the order of covariates written in the config file matters. The first covariate should reflect the group that appears on the right side of a volcano plot, and the second covariate is the left side of a volcano plot. Additional covariates can be specified without further constraints.


Expected output files

The pipeline produces Parquet files that are scanned, selected, filtered, and collected to be served to the user's front-end.

results/
├── deg
│   ├── adjp.parquet
│   ├── deg.parquet
│   ├── log2fc.parquet
│   ├── means.parquet
│   ├── meta.parquet
│   ├── summaries.parquet
│   ├── t-adjp.parquet
│   └── t-log2fc.parquet
└── gsea
    ├── results.parquet
    ├── meta.parquet
    ├── summaries.parquet
    ...

Usage

Install ADEX with pip (Python 3.13 or newer), then run the commands from the directory containing your project configuration and input data:

# Install ADEX
python -m pip install git+https://github.com/aifimmunology/sc-deg-explorer.git

# Prepare config/template.json with project-specific settings and data paths.

# Preprocess differential results
adex-preprocess --config config/template.json

# Start the dashboard
adex-app --config config/template.json

For development from a source checkout, install the Pixi environment with pixi install --frozen, then run:

pixi run python preprocess.py --config config/template.json
pixi run python app.py --config config/template.json

Example Output

The following screenshot is an example of a working app. After starting the app, it can be accessed via the following URL: http://0.0.0.0:8050/

MA Plot


Test build with Docker

Local builds with Docker can be helpful before deploying to a remote server for production.

docker build --platform=linux/arm64/v8 -t rheumatoid-arthritis . # 'rheumatoid-arthritis' can be any string
docker run -p 8050:8050 rheumatoid-arthritis

The app will be available at http://localhost:8050.

Metadata

Release files for ADEX 0.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 ADEX 0.1.0
File Size Uploaded Provenance Actions
adex-0.1.0.tar.gz 5.1 MB Without provenance Details for adex-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ADEX 0.1.0
File Interpreter ABI Platform Actions
adex-0.1.0-py3-none-any.whl Python 3 none any Details for adex-0.1.0-py3-none-any.whl

Total release size: 10.3 MB

Release files / adex-0.1.0.tar.gz

Download URL adex-0.1.0.tar.gz
Size 5.1 MB
Tags Source
SHA-256 checksum
How to use checksums
4ba6f392fcff8cf1c9fbf24a974119732ebf46d96f954fd7d64c38bc425f9771
BLAKE2b-256 checksum
How to use checksums
9c460aa66a1c4f1281b5fa337c71441bf6850b547d1aadba72a04f40a12ac666
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / adex-0.1.0-py3-none-any.whl

Download URL adex-0.1.0-py3-none-any.whl
Size 5.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
44308a43147530bfb953ea7fcdc7f649017f9011d0fa9ee2efb207414fdba9ac
BLAKE2b-256 checksum
How to use checksums
f8fde71401403d43e6146d6b16af49b95e651a95f0aa634bf1b86186cdcaf73f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for ADEX 0.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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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