Metadata-Version: 2.1
Name: ibd-dendrogram
Version: 0.12.4
Summary: module that helps to form a dendrogram
Home-page: https://github.com/jtb324/ibd_dendrogram
Keywords: python, dendrogram,IBD,genetics,relatedness
Author: jtb
Author-email: james.baker@vanderbilt.edu
Requires-Python: >=3.10,<3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: matplotlib (>=3.5.1,<4.0.0)
Requires-Dist: numpy (>=1.22.2,<2.0.0)
Requires-Dist: pandas (>=1.4.1,<2.0.0)
Requires-Dist: scipy (>=1.8.0,<2.0.0)
Project-URL: Repository, https://github.com/jtb324/ibd_dendrogram
Description-Content-Type: text/markdown

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI version](https://badge.fury.io/py/ibd_dendrogram.svg)](https://badge.fury.io/py/ibd_dendrogram)
[![Documentation Status](https://readthedocs.org/projects/ibd-dendrogram/badge/?version=latest)](https://ibd-dendrogram.readthedocs.io/en/latest/?badge=latest)

# ibd-dendrogram:

A python module to help users create a distance matrix and construct a dendrogram using Identity by Descent segments as a distance marker. The default distance is calculated as 1/(shared ibd segment length). Documentation explaining the api can be found here: [ibd-dendrogram docs](https://ibd-dendrogram.readthedocs.io/en/latest/) 

This module has four accessible methods: make_distance_matrix, record_matrix, generate_dendrogram, draw_dendrogram.


