Add mardia watson wheeler

src/pingouin/circular.py

@@ -1,3 +1,3 @@
 # Author: Raphael Vallat <[email protected]>
 # Date: July 2018
 # Python code inspired from the CircStats MATLAB toolbox (Berens 2009)
@@ -6,7 +6,7 @@
 # Berens, Philipp. 2009. CircStat: A MATLAB Toolbox for Circular Statistics.
 # Journal of Statistical Software, Articles 31 (10): 1–21.
 import numpy as np
-from scipy.stats import norm
+from scipy.stats import norm, chi2
 
 from .utils import remove_na
 
@@ -764,3 +764,81 @@
     u = v * np.sqrt(2 / n)
     pval = 1 - norm.cdf(u)
     return v, pval
+
+def circ_mardia_watson_wheeler(data, group):
+    """
+    Mardia–Watson–Wheeler two-sample test for circular data.
+
+    Parameters
+    ----------
+    data : array_like
+        Array of circular values (in radians).
+    group : array_like
+        Group labels (same length as `data`), can be more than 2 groups.
+
+    Returns
+    -------
+    stat : float
+        W test statistic.
+    pval : float
+        Associated p-value.
+    df: float
+        Degree of freedom, corresponding to the number of groups.
+
+    Notes
+    -----
+    Based on Batschelet (1981), p. 144. Transitioned from Circular package in R
+    """
+    data = np.asarray(data)
+    group = np.asarray(group)
+    assert len(data) == len(group), "Data and group must be same length"
+    # Remove missing values
+    mask = ~np.isnan(data) & (group == group)
+    data = data[mask]
+    group = group[mask]
+
+    if len(data) == 0 or len(np.unique(group)) < 2:
+        raise ValueError("No observations or less than two groups after removing missing values.")
+
+    # Check for ties
+    nb_ties = len(data) - len(np.unique(data))
+    if nb_ties > 0:
+        print(f"Warning: {nb_ties} tie(s) detected. Ties will be broken randomly.")
+
+
+    group_labels, group_indices = np.unique(group, return_inverse=True)
+    k = len(group_labels)
+    n = len(data)
+
+    # break ties and 
+    rnd = np.random.random(size=n)
+    # lexsort uses the last key as primary, earlier keys as tie-breakers
+    # so we pass (rnd, x)—x is primary, rnd breaks ties
+    order = np.lexsort((rnd, data))
+    ranks = np.empty(n, dtype=int)
+    ranks[order] = np.arange(1, n+1)
+
+
+    # circular ranks (scale between 0 - 2 pi)
+    cr = ranks * 2 * np.pi / n
+
+    # Compute sum of cosine and sine components for each group
+    C = np.zeros(k)
+    S = np.zeros(k)
+    ns = np.zeros(k)
+    for i in range(k):
+        idx = group_indices == i
+        ns[i] = np.sum(idx)
+        C[i] = np.sum(np.cos(cr[idx]))
+        S[i] = np.sum(np.sin(cr[idx]))
+
+    if k == 2:
+        W = 2 * (n - 1) * (C[0]**2 + S[0]**2) / (ns[0] * ns[1])
+        df = 2
+    else:
+        W = 2 * np.sum((C**2 + S**2) / ns)
+        df = 2 * (k - 1)
+
+    p_value = 1 - chi2.cdf(W, df)
+
+    return W, p_value, df

tests/test_circular.py

@@ -1,3 +1,3 @@
 import pytest
 import numpy as np
 from unittest import TestCase
@@ -11,7 +11,7 @@
     circ_mean,
     circ_r,
     circ_rayleigh,
-    circ_vtest,
+    circ_vtest,circ_mardia_watson_wheeler,
 )
 
 np.random.seed(123)
@@ -151,3 +151,21 @@
         v, pval = circ_vtest(x, dir=0.5, w=[0.1, 0.2, 0.3, 0.4, 0.5], d=0.2)
         assert round(v, 3) == 0.637
         assert round(pval, 4) == 0.2309
+
+    def test_circ_mardia_watson_wheeler(self):
+        """Test function circ_mardia_watson_wheeler. Running the following test in r results in data:  1 and 2
+            W = 3.6783, df = 2, p-value = 0.159"""
+        x1_deg = np.array([35, 45, 50, 55, 60, 70, 85, 95, 105, 120])
+        x2_deg = np.array([75, 80, 90, 100, 110, 130, 135, 140, 150, 160, 165])
+
+        # Convert to radians
+        x1 = np.deg2rad(x1_deg)
+        x2 = np.deg2rad(x2_deg)
+
+        # Stack data
+        angles = np.concatenate([x1, x2])
+        groups = np.array([0] * len(x1) + [1] * len(x2))
+        W, p_value, df = circ_mardia_watson_wheeler(angles, groups)
+        np.testing.assert_allclose(W, 3.6783, atol=0.01)
+        np.testing.assert_allclose(p_value, 0.159, atol=0.01)
+        assert df == 2