RunasSudo/scipy-yli
1
Fork 0
Code Issues 1 Pull Requests Releases Activity

Clarify documentation for Mann-Whitney test

Browse Source
This commit is contained in:
RunasSudo 2022-10-20 20:57:24 +11:00
parent 05e5189fc5
commit 5248abf859
Signed by: RunasSudo
GPG Key ID: 7234E476BF21C61A
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
yli/sig_tests.py
View File

@ -306,6 +306,10 @@ def mannwhitney(df, dep, ind, *, nan_policy='warn', brunnermunzel=True, use_cont
:param alternative: See *scipy.stats.mannwhitneyu* :param alternative: See *scipy.stats.mannwhitneyu*
:param method: 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` :rtype: :class:`yli.sig_tests.MannWhitneyResult`
**Example:** **Example:**