.. SMAP documentation master file, created by
   sphinx-quickstart on Wed Aug  5 13:28:17 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


.. _SMAPrelatednessindex:

SMAP relatedness
================

.. image:: ../images/logo/SMAP_logo_v3.png
   :width: 200px
   :align: right

| This is the manual for the **SMAP relatedness** module of the SMAP package.  
| **SMAP relatedness** can either create genetic relationship matrices (pairwise) or perform clustering using Uniform Manifold Approximation and Projection (umap) based on multi-allelic haplotypes generated by **SMAP haplotype-sites** or **SMAP haplotype-window**.

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   SMAP relatedness umap <umap/index>
   SMAP relatedness pairwise <pairwise/index>