Metadata-Version: 2.5
Name: altar-popfreq
Version: 0.4.0
Summary: gnomAD population allele-frequency annotation-source binding for Altar
Project-URL: Documentation, https://kundajelab.github.io/altar/
Author: Riya Sinha
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: altar[gcs]<0.5,>=0.4.0
Provides-Extra: build
Requires-Dist: duckdb>=1.0.0; extra == 'build'
Requires-Dist: pyarrow>=17.0.0; extra == 'build'
Provides-Extra: test
Requires-Dist: pytest-asyncio>=0.24; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# altar-popfreq

`altar-popfreq` adds [gnomAD](https://gnomad.broadinstitute.org/) v4 population allele frequencies to Altar runs,
as the `gnomad` annotation source: frequencies overall and per genetic ancestry group, allele counts and site
filters.

Maturity: Stable; reading your own BigQuery table (`table`) is Preview: tested on the BigQuery emulator and
DuckDB; not run against live BigQuery. Validation: Matches upstream on spot checks.

The package is not called `gnomad` because gnomAD's [policies](https://gnomad.broadinstitute.org/policies) ask
that tools not use "gnomAD" or "Genome Aggregation Database" in their names.

## Install

```console
pip install altar-popfreq
```

The source reads gnomAD v4.1.1 genomes on hg38 from a public bucket the Kundaje lab publishes, with no download
and no credentials. To build another v4 release or dataset, such as exomes or joint:

```console
altar-popfreq-build --dataset genomes --release 4.1.1 --input gnomad.genomes.v4.1.1.sites.chr*.vcf.bgz \
  --output ./gnomad-4.1.1-genomes
```

## Use it in a run spec

```toml
[sources.gnomad]
type = "gnomad"
```

`altar sources gnomad` lists the columns and options.

Documentation: <https://kundajelab.github.io/altar/integrations/gnomad/>

## Cite and terms

- gnomAD: Chen S, et al. A genomic mutational constraint map using variation in 76,156 human genomes. *Nature*
  2024;625:92–100. doi:10.1038/s41586-023-06045-0. Name the release you used, such as "gnomAD v4.1.1 genomes".
- Terms: gnomAD's primary data is CC0 ([terms](https://gnomad.broadinstitute.org/terms)); do not attempt to
  re-identify participants. The package ships no gnomAD data and is not affiliated with or endorsed by the gnomAD
  project. gnomAD is a trademark of The Broad Institute, Inc.

## Licence

MIT.
