crispyn.correlations
====================

.. py:module:: crispyn.correlations


Functions
---------

.. autoapisummary::

   crispyn.correlations.spearman
   crispyn.correlations.weighted_spearman
   crispyn.correlations.pearson_coeff


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

.. py:function:: spearman(R, Q)

   Calculate Spearman rank correlation coefficient between two vectors

   Parameters
   -----------
       R : ndarray
           First vector containing values
       Q : ndarray
           Second vector containing values

   Returns
   --------
       float
           Value of correlation coefficient between two vectors

   Examples
   ----------
   >>> rS = spearman(R, Q)


.. py:function:: weighted_spearman(R, Q)

   Calculate Weighted Spearman rank correlation coefficient between two vectors

   Parameters
   -----------
       R : ndarray
           First vector containing values
       Q : ndarray
           Second vector containing values

   Returns
   --------
       float
           Value of correlation coefficient between two vectors

   Examples
   ---------
   >>> rW = weighted_spearman(R, Q)


.. py:function:: pearson_coeff(R, Q)

   Calculate Pearson correlation coefficient between two vectors

   Parameters
   -----------
       R : ndarray
           First vector containing values
       Q : ndarray
           Second vector containing values

   Returns
   --------
       float
           Value of correlation coefficient between two vectors

   Examples
   ----------
   >>> corr = pearson_coeff(R, Q)