CADD Threshold APP
A Shiny-for-Python web application to explore and compare distributions of ClinVar variants across different CADD PHRED-score thresholds, filter by gene lists or panels, and export per-gene/per-panel or filtered annotation summaries. The app is primarily intended for investigating the score distribution of known pathogenic and benign variants for different CADD PHRED-score thresholds.
Access via: https://cadd-threshold.kircherlab.bihealth.org
This README explains the repository layout, how to run the app locally (pip/conda).
Highlights
- Interactive visualizations of CADD PHRED-score distributions
- Compare distributions across CADD/ClinVar versions and genome builds
- Per-gene filtering (paste a list or upload a file) and exportable summaries
- Per-panel filtering using panels from PanelApp and exportable summaries
Requirements
- Python 3.10+ (3.12 recommended)
- See
requirements.txtorenvironment.ymlfor full dependencies - Docker (optional) — a
Dockerfileis included for containerized runs
Installation
Data preperation
The underlying data for the CADD-ThresholdApp needs to be downloaded, if the source code is downloaded as a package from bioconda or pip. The data can be downloaded here: . The data is also versionized seperately from the packages. You can also preprocess your own data for the website using this Snakemake workflow: CADD_threshold_analysis.
Data overview
data/- contains preprocessed tables, panel summaries and metrics used by the app.paneldata/- CSVs summarizing panels and versions used by the UIpanel_metrics/- generated metrics stored by date/version
Notes:
- Large raw annotation files are typically not tracked in the repository. The app
expects prepared/normalized CSV inputs - use https://github.com/kircherlab/CADD_threshold_analysis to regenerate CSV inputs or use the
modules/panelapp/utilities if you need to regenerate panel CSVs from PanelApp. - if you choose to use your own data you need to make sure that the beginning of the file contains an identifier (e.g. GRCh37-v1.7 for our use case)
- you also need to edit the
VERSION_GR_CHOICESin theui_components.pyfile with you identifiers (and incalculate_panel_metrics_and_save.py) - additionally you need to change the file names in the
data_loader.pyand change column names that are being called (ClinicalSignificance,GeneName,PHRED,Genesetc.)
How to update Panel Data
- if you want to update the Panel Data, you need to run
modules\panelapp\main_panelapp.py - If you run this, the Panel Overview will be updated and the old one will be saved as a backup, then the new metrics for all versions and genome releases will be calculated (Note: this takes several hours)
Pre-compiled packages
Using conda
conda create -n cadd_threshold_app -c bioconda -c conda-forge cadd-threshold-app
conda activate cadd_threshold_app
cadd-threshold-app --data </path/to/data>
Using pip
pip install cadd-threshold-app
cadd-threshold-app --data </path/to/data>
From source
git clone https://github.com/kircherlab/CADD_threshold_app.git
cd CADD_threshold_app
pip install .
cadd-threshold-app --data data
Install as package (editable, recommended for development)
pip install -e .
Run the app
Option A: run via the package entry point
This requires installing the project as a package (e.g. pip install -e .).
cadd-threshold-app --data </path/to/data>
Alternatively to the cli option --data, you can set the CADD_THRESHOLD_APP_DATA_DIR environment variable.
export CADD_THRESHOLD_APP_DATA_DIR=data
cadd-threshold-app
Further CLI options are available to configute host and port - run cadd-threshold-app --help for details.
Option B: run from the repository root. Please set the CADD_THRESHOLD_APP_DATA_DIR environment variable to point to your data directory (e.g. data/ in the repository) before running.
export CADD_THRESHOLD_APP_DATA_DIR=data
python -m shiny run cadd_threshold_app.app:app
Then open http://localhost:8080 in your browser.
Key files and modules
app.py- Shiny app entrypoint and UI wiringserver_logic.py- main server-side reactive logic and handlersdata_loader.py- helpers to load and preprocess annotation tablesui_components.py- UImodules/- plotting helpers, utilities and gene-list/panel parsing helpersbasic_plot.py,basic_bar_plot.py,compare_basic_plot.py- plotting factoriesfunctions_server_helpers.py,read_genes_from_list_or_file_functions.py- utilitiespanelapp/- scripts to interact with PanelApp (CSV generation, comparison)
Development notes
- To extend plots: add a factory under
modules/and register it in server logic - To add data sources: update
data_loader.pyand ensure column names match the plotting/metric code paths - Linting/tests: None included by default. Add unit tests for critical data parsing when making larger refactors.
Docker
- The included
Dockerfilebuilds a minimal image running the app on port 8080.
License & contact
- See
LICENSEfor licensing terms. - For questions about data sources, interpretation, or contributions, contact the repository maintainers or open an issue.
Metadata
Release files for cadd-threshold-app 0.0.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cadd_threshold_app-0.0.11.tar.gz | 622.8 kB | Without provenance | Details for cadd_threshold_app-0.0.11.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cadd_threshold_app-0.0.11-py3-none-any.whl | Python 3 | none | any | Details for cadd_threshold_app-0.0.11-py3-none-any.whl |
Total release size: 1.3 MB
Release files / cadd_threshold_app-0.0.11.tar.gz
| Download URL | cadd_threshold_app-0.0.11.tar.gz |
|---|---|
| Size | 622.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
10c8e22b1327da95f0ed05fa618f36a4e74e3eaf98eded7757aeeaec3eec3756
|
|
BLAKE2b-256 checksum How to use checksums |
48f494fd74c3809a28f7af6b1330d7c9321539b8316d43f0d1798559dabf29a5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / cadd_threshold_app-0.0.11-py3-none-any.whl
| Download URL | cadd_threshold_app-0.0.11-py3-none-any.whl |
|---|---|
| Size | 629.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
82655820e1b43ed006db160c0b34a8f6ab008a11d9bbf4f1bbff6f9ef85d8a10
|
|
BLAKE2b-256 checksum How to use checksums |
1bc8d3c7c207ec2f7f5bc9a82e1c932ddd627c7b132c7f3668e821607ffe680d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for cadd-threshold-app 0.0.11
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.