dial481 commited on
Commit
d8d2164
路
verified 路
1 Parent(s): 310d36f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +29 -5
README.md CHANGED
@@ -1,10 +1,34 @@
1
  ---
2
- title: README
3
- emoji: 馃殌
4
- colorFrom: indigo
5
- colorTo: yellow
6
  sdk: static
7
  pinned: false
 
8
  ---
9
 
10
- Edit this `README.md` markdown file to author your organization card.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Allelix
3
+ emoji: 馃К
4
+ colorFrom: blue
5
+ colorTo: indigo
6
  sdk: static
7
  pinned: false
8
+ short_description: Open-source genotype analysis. Offline-first.
9
  ---
10
 
11
+ # Allelix
12
+
13
+ **Open-source genotype analysis. Format-agnostic. Offline-first.**
14
+
15
+ Allelix reads your DNA file and reports what ClinVar, ClinPGx, the GWAS Catalog and SNPedia say about your variants. It adds frequencies and scores from gnomAD, AlphaMissense and CADD. It reads consumer chip files (23andMe, AncestryDNA, MyHeritage, FamilyTreeDNA, Living DNA and more) as well as VCF and gVCF from sequencing.
16
+
17
+ - **Private by design.** Everything runs on your machine. No telemetry, no uploads, no analytics.
18
+ - **Twelve input formats**, detected automatically.
19
+ - **Build-aware.** It works out the genome build from the file itself, and stops rather than guess.
20
+ - **Your choice of output:** HTML, JSON, terminal, or an annotated VCF for pipelines.
21
+
22
+ ```bash
23
+ pip install allelix
24
+ allelix db update # one-time download of the reference databases (about 19 GB)
25
+ allelix analyze your_genotype_file.txt --output report.html
26
+ ```
27
+
28
+ Requires Python 3.12 or newer.
29
+
30
+ [Website](https://allelix.io) 路 [Demo](https://analyze.allelix.io) 路 [GitHub](https://github.com/allelix/allelix) 路 [PyPI](https://pypi.org/project/allelix/) 路 [Changelog](https://github.com/allelix/allelix/blob/main/CHANGELOG.md)
31
+
32
+ Allelix is an informational research tool. It reports classifications made by external databases. It does not diagnose conditions or make health recommendations.
33
+
34
+ Licensed under AGPL-3.0-or-later.