Metadata-Version: 2.5
Name: altar-alphamissense
Version: 0.8.0
Summary: AlphaMissense 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<0.9,>=0.8.0
Provides-Extra: test
Requires-Dist: pytest-asyncio>=0.24; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# altar-alphamissense

`altar-alphamissense` adds [AlphaMissense](https://github.com/google-deepmind/alphamissense) predicted missense
pathogenicity to Altar runs, as the `alphamissense` annotation source, looked up in a copy of DeepMind's released
predictions.

Maturity: Stable. Validation: Not spot-checked.

## Install

```console
pip install altar-alphamissense
```

Build a copy from DeepMind's release, read in place from its public bucket (this needs `altar[gcs]`):

```console
altar-alphamissense-build --genome-build hg38 --release zenodo-v3 \
  --input gs://dm_alphamissense/AlphaMissense_hg38.tsv.gz --input-storage-option token=anon \
  --output ./alphamissense-hg38
```

## Use it in a run spec

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

[sources.alphamissense.options]
dataset = "alphamissense-hg38"
```

`altar sources alphamissense` lists the columns and options.

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

## Cite and terms

- AlphaMissense: Cheng J, et al. Accurate proteome-wide missense variant effect prediction with AlphaMissense.
  *Science* 2023;381(6664):eadg7492. doi:10.1126/science.adg7492. Name the release you used.
- Terms: DeepMind licenses the predictions in `gs://dm_alphamissense` and in Zenodo version 3 under CC BY 4.0. The
  first Zenodo version was CC BY-NC-SA 4.0; check the version you download. The package ships no AlphaMissense
  data.

## Licence

MIT.
