Skip to content
fgczPublic

About

exploreDE

Resources

Stars

1 star

Watchers

2 watching

Forks

Repository files navigation

exploreDE exploreDE cat-face volcano hex sticker

R-CMD-check

exploreDE is a Shiny app for exploring differential expression results from RNA-seq, proteomics and CRISPR screens, and for making publication-quality figures from them: ordination plots, heatmaps, volcano plots, box plots, GO and KEGG pathway views, ORA and GSEA results, and comparisons across contrasts.

It opens an AnnData .h5ad file in the exploreDE/1.0 layout, which build_explore_h5ad() writes from the results of any pipeline (DESeq2, edgeR, limma, prolfqua, SAINTexpress), and the results of the FGCZ SUSHI and prolfqua pipelines.

The Volcano Plots tab of exploreDE on the demo RNA-seq dataset: the menu of all tabs on the left, the plot settings in the middle, and a volcano plot of the diff vs undiff contrast with up- and down-regulated genes in red and blue.

Documentation: https://fgcz.github.io/exploreDE/

Installation

exploreDE is submitted to Bioconductor. Until it is released there, install it from GitHub:

install.packages("BiocManager")
BiocManager::install("fgcz/exploreDE") # needs Bioconductor >= 3.23 (anndataR >= 1.2.3)

Once it is on Bioconductor:

BiocManager::install("exploreDE")

Optional: KEGG pathway views, GLM-PCA, and formatted group labels. Without these packages the app hides the feature or shows plain text.

BiocManager::install(c("pathview", "glmpca", "ggtext", "gridtext"))

Quick start

library(exploreDE)
exploreDE()                            # landing page: upload a file or load the demo dataset
exploreDE("my_data.h5ad")              # open a file directly
exploreDE(c("a.h5ad", "b.h5ad"))       # compare the contrasts of several files
exploreDE(se)                          # open a SummarizedExperiment or AnnData object

The menu shows only the tabs your data supports: DE tabs need a DE table, pathway tabs need enrichment results.

Documentation

  • vignette("exploreDE"): the app's tabs, and opening a dataset in R
  • vignette("bring-your-own-data", package = "exploreDE"): building a file from your own results: counts only, proteomics, RNA-seq with pathways, organisms without an annotation package, and unrecognised column names
  • ?build_explore_h5ad: the argument reference
  • system.file("spec/exploreDE-h5ad-1.0.md", package = "exploreDE"): the .h5ad format, for writing files from Python or another tool
  • system.file("skills/exploreDE-byod/SKILL.md", package = "exploreDE"): give this to an AI assistant to have it write the import script for your data

Bring your own data

Only counts, a sample table and the omics type are required; DE tables and pathway results are optional.

build_explore_h5ad(
  counts,                                   # features x samples matrix
  out     = "my_data.h5ad",
  omics   = "rnaseq",                       # or "proteomics", "crispr"
  coldata = coldata,                        # one row per sample, rownames = colnames(counts)
  rowdata = annotation,                     # optional: gene ids, symbols, GO terms, ...
  de      = list(Treat_vs_Ctrl = de_table)  # optional: one table per contrast
)

You don't need to rename columns: a dictionary recognises the usual DESeq2, edgeR, limma, prolfqua and SAINTexpress names, and warns when it can't place one. The prolfquapp DEA's AnnData.h5ad (prolfquapp 2.10.x) opens as it is.

Saving your settings

The Save / Load Session tab downloads your settings across every tab (widgets, the feature bucket, pathway selections and Multi DE datasets) as one .json file, and restores them on the same dataset later. It holds no data. Format: system.file("spec/exploreDE-session-2.md", package = "exploreDE").

Running on a server

On a server, ?data= opens a dataset from the link:

  • ?data=<result directory>: a SUSHI result on FGCZ's gStore (LDAP-checked)
  • ?data=<percent-encoded https link to an .h5ad>: a file from an allowed source (by default APB Export jobs and public pStore; set EXPLOREDE_URL_SOURCES to change the list). Plain https:// only, no redirects, up to 1 GB.

The LDAP check takes the user from the SHINYPROXY_USERNAME environment variable, read once per R process, so run the app behind ShinyProxy with one container per user. Without that variable (plain Shiny Server, for example) every gStore link is refused; the demo, uploads and https:// links still work.

Getting help

AI use and provenance

AI coding agents helped write this package:

  • Tools: Claude Code (Anthropic), and in-house open-weight models such as Qwen
  • Extent: the review fixes, refactoring, tests and documentation of the Bioconductor submission in late 2026; the app itself was written from 2025 on by Peter Leary and contributors
  • Marking: commits written with AI help carry an Assisted-by: AI coding agent trailer since 2 November 2026; earlier commits are not marked, so treat the whole code base as AI-assisted
  • Review: the maintainer reviewed every change before committing it
  • Testing: the testthat suite covers the dataset classes, the .h5ad builder and reader, and the session format; shinytest2 tests drive the app in a browser; R CMD check, BiocCheck, lintr and the browser tests run in CI on every push

Provenance and licence:

  • No code is copied from other software projects
  • The example datasets and their sources are listed in inst/examples/README.md
  • Anthropic's terms assign the rights in generated output to the user, and the open-weight models' licences claim no rights in it, so all code can be redistributed under this package's MIT licence

The maintainer is responsible for all code in this package, whatever helped write it, and for its reliability and maintenance.

Citing exploreDE

See CITATION.cff.

About

exploreDE

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages