Metadata-Version: 2.5
Name: altar-clinvar
Version: 0.4.0
Summary: ClinVar germline-classification 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-clinvar

`altar-clinvar` adds [ClinVar](https://www.ncbi.nlm.nih.gov/clinvar/)'s aggregate germline classifications to
Altar runs, as the `clinvar` annotation source: classification, review stars, conditions, genes and molecular
consequences.

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.

## Install

```console
pip install altar-clinvar
```

The source reads ClinVar 20260928 on hg38 from a public bucket the Kundaje lab publishes, with no download and no
credentials. To build a newer release, or hg19:

```console
altar-clinvar-build --release 20261005 --genome-build hg38 \
  --input clinvar_20261005.vcf.gz clinvar_20261005_papu.vcf.gz --output ./clinvar-20261005-hg38
```

## Use it in a run spec

```toml
[sources.clinvar]
type = "clinvar"
options = { prioritize_pathogenic = true }  # optional: let reviewed pathogenic records set `prioritized`
```

`altar sources clinvar` lists the columns and options.

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

## Cite and terms

- ClinVar: Landrum MJ, et al. ClinVar: improving access to variant interpretations and supporting evidence.
  *Nucleic Acids Research* 2018;46(D1):D1062–D1067. doi:10.1093/nar/gkx1153. PMID 29165669. Name the release you
  used, such as "ClinVar 20260928".
- Terms: NCBI places no restrictions on the use or distribution of ClinVar data and asks for attribution to
  ClinVar ([data use policy](https://www.ncbi.nlm.nih.gov/clinvar/docs/maintenance_use/)). ClinVar is not intended
  for direct diagnostic use without review by a genetics professional. The package ships no ClinVar data and is
  not affiliated with or endorsed by NCBI.

## Licence

MIT.
