Context-aware QC scoring for variant calling (Picard + biobambam2)
Project description
Turn post-alignment QC metrics into a PASS / WARN / FAIL verdict you can act on
VarGate reads post-alignment QC metrics (Picard + biobambam2 markdup) for one tumor/normal pair and returns an actionable verdict (PASS / WARN / FAIL), calibrated via a YAML profile for the downstream analysis.
It was built for somatic variant calling and defaults to that workflow, but YAML profiles allow thresholds and rules to be customized for other workflows. It processes one patient at a time and fits into Snakemake loops over wildcards.
VarGate ingests Picard CollectWgsMetrics, CollectAlignmentSummaryMetrics, CollectInsertSizeMetrics, and optionally CollectGcBiasMetrics, plus biobambam2 bammarkduplicates2, and writes a self-contained HTML report and a TSV summary.
Custom profiles can be added under src/vargate/profiles/.
Installation
pip install vargate
Or from source:
git clone https://github.com/pieetie/vargate
cd vargate
pip install -e ".[dev]"
Quick start
vargate \
--tumor T1 \
--normal N1 \
--input metrics/ \
--output patient1_qc \
--label "Patient 1"
Produces patient1_qc.html (self-contained report) and patient1_qc.tsv.
Credits
- Logo and visual identity - Elisa Perrin
- Claude (Anthropic) - assisted with tests, documentation, refactoring, HTML report styling, script cleanup, and CLI extensions to cover more use cases
Citation
If you use VarGate in your work, please cite it via the CITATION.cff file or directly:
Natiez, P. (2026). VarGate (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.20376751
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vargate-1.0.0.tar.gz.
File metadata
- Download URL: vargate-1.0.0.tar.gz
- Upload date:
- Size: 26.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b1b43a127aa05b49a16d0c3d7732230d4852f899fa08d6e07400034364e6ded
|
|
| MD5 |
26dfd19d947ed7a7ce1721c14577dbd0
|
|
| BLAKE2b-256 |
fbc86bfbc964fe69d5d2929c5d5f799b13490a5f6a945c7a12228acab41358f5
|
Provenance
The following attestation bundles were made for vargate-1.0.0.tar.gz:
Publisher:
publish.yml on pieetie/vargate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vargate-1.0.0.tar.gz -
Subject digest:
5b1b43a127aa05b49a16d0c3d7732230d4852f899fa08d6e07400034364e6ded - Sigstore transparency entry: 1629189604
- Sigstore integration time:
-
Permalink:
pieetie/vargate@7354eb79305101d835797adb83a10926b3db36cf -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/pieetie
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7354eb79305101d835797adb83a10926b3db36cf -
Trigger Event:
push
-
Statement type:
File details
Details for the file vargate-1.0.0-py3-none-any.whl.
File metadata
- Download URL: vargate-1.0.0-py3-none-any.whl
- Upload date:
- Size: 22.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cc40f6a4cb762ba55b8a3e8ac4919dca48bbcb5f05162a3e463ad7b52c186263
|
|
| MD5 |
5f261b5a9f2b58b28e21f0aafb323458
|
|
| BLAKE2b-256 |
e49d997a1cb3d97dcffd0cade5fa4eadb7af55e4789917bb41770e9ebf470d99
|
Provenance
The following attestation bundles were made for vargate-1.0.0-py3-none-any.whl:
Publisher:
publish.yml on pieetie/vargate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vargate-1.0.0-py3-none-any.whl -
Subject digest:
cc40f6a4cb762ba55b8a3e8ac4919dca48bbcb5f05162a3e463ad7b52c186263 - Sigstore transparency entry: 1629189637
- Sigstore integration time:
-
Permalink:
pieetie/vargate@7354eb79305101d835797adb83a10926b3db36cf -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/pieetie
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7354eb79305101d835797adb83a10926b3db36cf -
Trigger Event:
push
-
Statement type: