.. _f-corrplot:

module ``graphhelper.corrplot``
===============================





.. inheritance-diagram:: pyensae.graphhelper.corrplot


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

module ``pyensae.graphhelper.corrplot``

CorrPlot functionalities.

It comes from `corrplot.py <https://raw.githubusercontent.com/biokit/biokit/master/biokit/viz/corrplot.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
:references: http://cran.r-project.org/web/packages/corrplot/vignettes/corrplot-intro.html


:githublink:`%|py|12`




Classes
+++++++

+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| class                                                     | truncated documentation                                                                                              |
+===========================================================+======================================================================================================================+
| :class:`Corrplot <pyensae.graphhelper.corrplot.Corrplot>` | An implementation of correlation plotting tools (corrplot). the class requires `scipy <http://www.scipy.org/>`_. ... |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| method                                                                                 | truncated documentation                                                                                     |
+========================================================================================+=============================================================================================================+
| :py:meth:`__init__ <pyensae.graphhelper.corrplot.Corrplot.__init__>`                   | Plots the content of square matrix that contains correlation values.                                        |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :py:meth:`_add_patches <pyensae.graphhelper.corrplot.Corrplot._add_patches>`           |                                                                                                             |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :py:meth:`_set_default_cmap <pyensae.graphhelper.corrplot.Corrplot._set_default_cmap>` |                                                                                                             |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :meth:`order <pyensae.graphhelper.corrplot.Corrplot.order>`                            | Rearranges the order of rows and columns after clustering.                                                  |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :meth:`plot <pyensae.graphhelper.corrplot.Corrplot.plot>`                              | Plots the correlation matrix from the content of :attr:`df` (dataframe). By default, the correlation is ... |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+


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

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