bioforensics / MicroHapulator

Tools for empirical microhaplotype calling, forensic interpretation, and simulation.
https://microhapulator.readthedocs.io/
Other
6 stars 1 forks source link

Terminology update: "allele" to "haplotype", "allele_counts" to "typing_result" #109

Closed standage closed 2 years ago

standage commented 2 years ago

I've developed a more precise and refined forensic vocabulary since first working on this project, but vestiges of my original terminology remain. The purpose of this PR is to bring the profile JSON schema (and, where reasonable, variable names in code) up to date.

This branch touches a lot of files, but most of the changes are subtle. For instance, in the JSON files, the "allele" key was replaced with "haplotype", the "haplotype" key (referring to the haplotype of origin when inferred or known such as for simulated profiles) was replaced with "haploindex", and the "allele_counts" key was replaced with "typing_result". Similar changes were propagated in the Python API, the core modules, and code in the test suite.

Also, updated .gitattributes to correctly mark .ipynb files as documentation. Closes #108.