Altar¶
Pre-release documentation
These pages describe Altar 0.4.0, which is not yet on PyPI. pip install altar installs 0.3.0, which lacks some
commands shown here. To follow these pages now, install the development branch.
Altar scores genomic variants with sequence models and annotates them with published evidence, in one run that writes one table. You describe the run in a TOML file: your variants, the models, the annotation sources and where to keep the scores. Altar runs each model in a container on your machine or a cluster, or calls its hosted API. It looks up the evidence, and records which model, settings and dataset release produced every value.
Beta
Altar is in beta. Each interface and feature is labelled Stable, Provisional or Preview. See Maturity labels.
What Altar is¶
- A command,
altar run, and a Python library for scoring and annotating a variant cohort. - Bindings, separate packages that connect Altar to seven models (ChromBPNet, Cherimoya, Enformer, Borzoi, LegNet, Sei and AlphaGenome) and to evidence such as gnomAD, ClinVar, phyloP, AlphaMissense, SpliceAI and enhancer-to-gene links.
- A score store that keeps every model's scores, so a later run scores only the variants it has not seen.
- A set of interfaces for adding your own model, dataset, compute backend or store.
What Altar is not¶
- A variant-effect model of its own. It runs other people's models.
- A clinical tool. A prioritized variant is one that a declared rule matched; it is not a pathogenicity call. See Limitations.
- A consequence annotator such as VEP. It does not produce HGVS or transcript consequences.
- A hosted service. You install it and run it on your own machine or cluster.
Start here¶
-
Annotate a VCF
Add gnomAD frequencies and ClinVar classifications to your variants. Needs only Python.
-
Score with a model
Score variants with LegNet on the CPU, then with GPU or hosted models.
-
Use it from Python
Start runs, look up evidence and read stored scores from your own application.
-
Extend it
Add a model binding, an annotation source, an execution backend or a result store.
To understand what the results mean before you use them, read From variants to evidence.