Skip to content

Tools for empirical microhaplotype calling, forensic interpretation, and simulation.

License

Notifications You must be signed in to change notification settings

bioforensics/MicroHapulator

Repository files navigation

MicroHapulator build status Test coverage Platform support install with bioconda BSD licensed

MicroHapulator

MicroHapulator is software for empirical haplotype calling, analysis, and basic forensic interpretation of microhaplotypes from Illumina sequence data. Also included are tools for constructing mock genotypes and simulating Illumina sequencing of single- and multiple-contributor samples for testing and development purposes. MicroHapulator can be configured for use with any published or custom panel. MicroHapDB can be used to prepare marker definitions, population frequencies, and reference sequences—see the configuration documentation for more details.

Installation

Installation with the Conda package manager is recommended. Full installation instructions are available here.

conda install -c bioconda microhapulator

NOTE: MicroHapulator is only supported on Windows through the Windows Subsystem for Linux (WSL2).

Usage

The MicroHapulator user manual is a good place to start. There is also a reference for the command line interface and the Python API. For a quick interactive demo, click the badge below.

Binder

Contributing

MicroHapulator was created by Daniel Standage, with the support of the National Bioforensic Analysis Center (NBFAC). Contributions from the broader community are welcomed! Feel free to ask questions, make suggestions, or report bugs using the issue tracker. If you are interested in submitting patches, the developer documentation contains a few suggestions for a development setup. All contributors are expected to abide by the project's Code of Conduct.