Document sign change in emd

Closes #130
KrishnaswamyLab · May 14, 2022 · 926d7be · 926d7be
1 parent c1cad1e
commit 926d7be
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/scprep/stats.py b/scprep/stats.py
@@ -550,6 +550,11 @@ def differential_expression(
     X, Y, measure="difference", direction="both", gene_names=None, n_jobs=-2
 ):
     """Calculate the most significant genes between two datasets.
+    
+    If using ``measure="emd"``, the test statistic is multiplied by the sign of
+    the mean differencein order to allow for distinguishing between positive
+    and negative shifts. To ignore this, use ``direction="both"`` to sort by the
+    absolute value.
 
     Parameters
     ----------