Skip to content

Commit

Permalink
Add README for haploid case
Browse files Browse the repository at this point in the history
  • Loading branch information
szhan committed Jun 19, 2024
1 parent a784916 commit 145b7cd
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# lshmm
code to run Li and Stephens
This is a Python library for prototyping and testing implementations of algorithms using the Li & Stephens (2003) HMM.

## Usage

### Inputs
Reference panel contains sample and/or (partial) ancestral haplotypes.

### Demo
Forwards algorithm
Backwards algorithm
Viterbi algorithm
Log-likelihood evaluation of a copying path

### Features
* Scaling of mutation rate by the number of distinct alleles per site.
* Non-copiable allelic state in the reference panel (`NONCOPY`).
* Missing allelic state in the query (`MISSING`).
* Multiallelic sites.

0 comments on commit 145b7cd

Please sign in to comment.