Metadata-Version: 2.5
Name: altar-conservation
Version: 0.9.3
Summary: Base-wise conservation score tracks (UCSC phyloP) 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.10,>=0.9.3
Provides-Extra: build
Requires-Dist: pybigtools>=0.3.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-conservation

`altar-conservation` adds UCSC's hg38 [phyloP 100-way](https://hgdownload.soe.ucsc.edu/goldenPath/hg38/phyloP100way/)
conservation score at each variant's base to Altar runs, as the `phylop100way` annotation source.

Maturity: Stable. Validation: Matches upstream on spot checks.

## Install

```console
pip install altar-conservation
```

The source reads the track from a public bucket the Kundaje lab publishes, with no download and no credentials.
To build your own copy from UCSC's bigWig:

```console
pip install "altar-conservation[build]"
altar-conservation-build --track phylop100way --input hg38.phyloP100way.bw --output ./phylop100way-hg38
```

## Use it in a run spec

```toml
[sources.phylop]
type = "phylop100way"
options = { indels = "max" }  # optional: score indels too, by the greatest score over their bases
```

`altar sources phylop100way` lists the column and options.

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

## Cite and terms

- phyloP: Pollard KS, et al. Detection of nonneutral substitution rates on mammalian phylogenies. *Genome
  Research* 2010;20(1):110–121. doi:10.1101/gr.097857.109.
- Conserved elements: Siepel A, et al. *Genome Research* 2005;15(8):1034–1050. doi:10.1101/gr.3715005.
- UCSC Genome Browser: Casper J, et al. *Nucleic Acids Research* 2026;54(D1):D1331–D1335. doi:10.1093/nar/gkaf1250.
- Terms: UCSC's phyloP files are freely available for public use; credit UCSC
  ([citing UCSC](https://genome.ucsc.edu/cite.html)). The package ships no data.

## Licence

MIT.
