.. _f-linkage:

module ``graphhelper.linkage``
==============================





.. inheritance-diagram:: pyensae.graphhelper.linkage


Short summary
+++++++++++++

module ``pyensae.graphhelper.linkage``

dendogram, heatmap functionalities.

It comes from `linkage.py <https://raw.githubusercontent.com/biokit/biokit/master/biokit/viz/linkage.py>`_
which I copied here because the module does not properly work on Python 3 (import issues).
See also `biokit license <https://github.com/biokit/biokit/blob/master/LICENSE>`_.

:author: Thomas Cokelaer



:githublink:`%|py|12`




Classes
+++++++

+--------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| class                                                  | truncated documentation                                                                           |
+========================================================+===================================================================================================+
| :class:`Linkage <pyensae.graphhelper.linkage.Linkage>` | Linkage used in other tools such as Heatmap, the class requires `scipy <http://www.scipy.org/>`_. |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------+










Methods
+++++++

+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| method                                                             | truncated documentation                                                                                                  |
+====================================================================+==========================================================================================================================+
| :py:meth:`__init__ <pyensae.graphhelper.linkage.Linkage.__init__>` | unused                                                                                                                   |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :meth:`linkage <pyensae.graphhelper.linkage.Linkage.linkage>`      | Mostly calls `linkage <https://docs.scipy.org/doc/scipy/reference/generated/scipy.cluster.hierarchy.linkage.html>`_. ... |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyensae.graphhelper.linkage
    :members:
    :special-members: __init__
    :show-inheritance: