[med-svn] [python-mne] 67/376: better docstring

[Yaroslav Halchenko]

This is an automated email from the git hooks/post-receive script.

yoh pushed a commit to annotated tag v0.1
in repository python-mne.

commit 0bd92c41e02190456c92665c20ade5acfa54e6c4
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Sun Feb 13 15:39:16 2011 -0500

    better docstring
---
 mne/stats/permutations.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/mne/stats/permutations.py b/mne/stats/permutations.py
index f960e36..7286304 100644
--- a/mne/stats/permutations.py
+++ b/mne/stats/permutations.py
@@ -36,6 +36,18 @@ def permutation_t_test(X, n_permutations=10000, tail=0):
         the alternative hypothesis is that the mean of the data is different
         than 0 (two tailed test).  If tail is -1, the alternative hypothesis
         is that the mean of the data is less than 0 (lower tailed test).
+
+    Returns
+    -------
+    p_values : array of shape [n_tests]
+        P-values for all the tests (aka variables)
+
+    T0 : array of shape [n_tests]
+        T-statistic for all variables
+
+    H0 : array of shape [n_permutations]
+        T-statistic obtained by permutations and t-max trick for multiple
+        comparison.
     """
     n_samples, n_tests = X.shape
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git