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

.. py:module:: statgis.statutils.stats

.. autoapi-nested-parse::

   Submodule to ease some statisticals



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


Functions
~~~~~~~~~

.. autoapisummary::

   statgis.statutils.stats.corr_matrix



.. py:function:: corr_matrix(data: pandas.DataFrame, variables: Union[numpy.typing.ArrayLike, None] = None, half: bool = False, hide_insignificants: bool = False, singificant_threshold: float = 0.05) -> pandas.DataFrame

   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 (optional)
   :param half: If True, only show the corerlation of the first half of the matrix,
                excluding the repeated correlation.
   :type half: bool (optional)
   :param hide_insignifcants: If True, hide all the correlation with a p-value greater than the
                              significant threshold.
   :type hide_insignifcants: bool (optional)
   :param siginificant_threshold: Threshold of significant correlation.
   :type siginificant_threshold: float (optional)

   :returns: **corr** -- Dataframe with the correlation values.
   :rtype: pd.DataFrame