Clarify documentation for Mann-Whitney test
This commit is contained in:
parent
05e5189fc5
commit
5248abf859
@ -306,6 +306,10 @@ def mannwhitney(df, dep, ind, *, nan_policy='warn', brunnermunzel=True, use_cont
|
||||
:param alternative: See *scipy.stats.mannwhitneyu*
|
||||
:param method: See *scipy.stats.mannwhitneyu*
|
||||
|
||||
:return: The result of the Mann–Whitney test.
|
||||
The result of a Brunner–Munzel test is included in the result object if and only if *brunnermunzel* is *True*,
|
||||
*and* the Mann–Whitney test is significant, *and* the Brunner–Munzel test is non-significant.
|
||||
|
||||
:rtype: :class:`yli.sig_tests.MannWhitneyResult`
|
||||
|
||||
**Example:**
|
||||
|
Loading…
Reference in New Issue
Block a user