Skip to main content

VarGate logo

Turn post-alignment QC metrics into a PASS / WARN / FAIL verdict you can act on

PyPI version License DOI


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 QC report preview

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

VarGate icon Distributed under the MIT License.

Metadata

Release files for vargate 1.0.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 vargate 1.0.0
File Size Uploaded
vargate-1.0.0.tar.gz 26.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for vargate 1.0.0
File Interpreter ABI Platform
vargate-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 48.8 kB

Release files / vargate-1.0.0.tar.gz

Download URL vargate-1.0.0.tar.gz
Size 26.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5b1b43a127aa05b49a16d0c3d7732230d4852f899fa08d6e07400034364e6ded
BLAKE2b-256 checksum
How to use checksums
fbc86bfbc964fe69d5d2929c5d5f799b13490a5f6a945c7a12228acab41358f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 25, 2026.

Transparency log

Release files / vargate-1.0.0-py3-none-any.whl

Download URL vargate-1.0.0-py3-none-any.whl
Size 22.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cc40f6a4cb762ba55b8a3e8ac4919dca48bbcb5f05162a3e463ad7b52c186263
BLAKE2b-256 checksum
How to use checksums
e49d997a1cb3d97dcffd0cade5fa4eadb7af55e4789917bb41770e9ebf470d99
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 25, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

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