.. module:: ggcorrplot

************************
ggcorrplot documentation
************************

**Date**: |today| **Version**: |release|

**Useful links**:
`Binary Installers <https://pypi.org/project/ggcorrplot/>`_ |
`Source Repository <https://github.com/enfantbenidedieu/ggcorrplot>`_ |
`Issues & Ideas <https://github.com/enfantbenidedieu/ggcorrplot/issues>`_ |

**Others packages**:
`scientisttools <https://pypi.org/project/scientisttools/>`_ | 
`scientistmetrics <https://pypi.org/project/scientistmetrics/>`_ | 
`scientistshiny <https://pypi.org/project/scientistshiny/>`_ |
`scientisttseries <https://pypi.org/project/scientistshiny/>`_ |
`discrimintools <https://pypi.org/project/discrimintools/>`_ |

`ggcorrplot <https://github.com/enfantbenidedieu/ggcorrplot>`_ is an open source `Python <https://www.python.org/>`_ library distributed under 
the MIT Licence. It is used to visualize easily a correlation matrix using `plotnine <https://plotnine.org/>`_.

.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card:: install
        :class-card: intro-card
        :shadow: md
        :width: 100%

        New to *ggcorrplot*? Check out the install guide.

        +++

        .. button-ref:: install
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the install guides

    .. grid-item-card:: Getting started
        :class-card: intro-card
        :shadow: md

        Check out the getting started guide.

        +++

        .. button-ref:: getting_started
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the getting started guide

    .. grid-item-card::  API reference
        :class-card: intro-card
        :shadow: md

        The reference describes how the methods work and which parameters can be used.

        +++

        .. button-ref:: api
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the reference guide

    .. grid-item-card::  Examples
        :class-card: intro-card
        :shadow: md

        Examples using ggcorrplot.

        +++

        .. button-ref:: examples
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the examples

    .. grid-item-card::  About Us
        :class-card: intro-card
        :shadow: md

        Contact Us.

        +++

        .. button-ref:: about_us
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the about us guide

    .. grid-item-card::  Citing ggcorrplot
        :class-card: intro-card
        :shadow: md

        Citing ggcorrplot.

        +++

        .. button-ref:: citing_ggcorrplot
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the citing ggcorrplot guide

.. toctree::
    :maxdepth: 3
    :hidden:
    :titlesonly:

    install/index
    getting_started/index
    reference/index
    examples/index