:py:mod:`statgis.statutils.plots`
=================================

.. py:module:: statgis.statutils.plots

.. autoapi-nested-parse::

   Submodule for generate statistical plots



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   statgis.statutils.plots.plot_corr_matrix



.. py:function:: plot_corr_matrix(data: pandas.DataFrame, variables: Union[numpy.typing.ArrayLike, None] = None, half: bool = False, hide_insignificant: bool = False, significant_threshold: float = 0.05, show_labels: bool = True, show_colorbar: bool = False, palette: str = 'Spectral', text_color: str = 'black', ax: Union[matplotlib.axes.Axes, None] = None) -> matplotlib.axes.Axes

   Calculate the pearson correlation matrix of the variables in a dataframe.

   :param data: Dataframe with the variables to evaluate their correlation.
   :type data: pd.DataFrame
   :param variables: The variables of interest, if it is not defined, all variables in
                     the dataframe will be evaluated.
   :type variables: ArrayLike | None = None
   :param half: If True, only show the correlation of the first half of the matrix,
                excluding the repeated correlation.
   :type half: bool (optional)
   :param hide_insignificant: If True, hide all the correlation with a p-value greater than the
                              significant threshold.
   :type hide_insignificant: bool (optional)
   :param significant_threshold: Threshold of significant correlation.
   :type significant_threshold: float (optional)
   :param show_labels: Show the correlation value.
   :type show_labels: bool (optional)
   :param show_colorbar: Show color-bar
   :type show_colorbar: bool (optional)
   :param palette: Color palette for correlation plot.
   :type palette: str (optional)
   :param text_color: Color of text correlation labels.
   :type text_color: str (optional)
   :param ax: Axes to draw the correlation matrix.
   :type ax: matplotlib.axes.Axes | None (optional)

   :returns: **ax** -- Correlation matrix.
   :rtype: matplotlib.axes.Axes