{"action":"created","comment":{"url":"https://api.github.com/repos/mne-tools/mne-python/pulls/comments/149773887","pull_request_review_id":75222084,"id":149773887,"diff_hunk":"@@ -944,20 +944,24 @@ def permutation_cluster_test(X, threshold=None, n_permutations=1024,\n         2 groups with respectively 20 and 17 observations in each.\n         Each data point is of shape (50, 4).\n     threshold : float | dict | None\n-        If threshold is None, it will choose a t-threshold equivalent to\n-        p < 0.05 for the given number of (within-subject) observations.\n+        If threshold is None, it will choose a f-threshold equivalent to\n+        p < 0.05 for the given number of observations (only valid when\n+        using an f-statistic).","path":"mne/stats/cluster_level.py","position":8,"original_position":8,"commit_id":"151857f9c0ec6635171359d10c00ef474dd43bbd","original_commit_id":"151857f9c0ec6635171359d10c00ef474dd43bbd","user":{"login":"cbrnr","id":4377312,"avatar_url":"https://avatars2.githubusercontent.com/u/4377312?v=4","gravatar_id":"","url":"https://api.github.com/users/cbrnr","html_url":"https://github.com/cbrnr","followers_url":"https://api.github.com/users/cbrnr/followers","following_url":"https://api.github.com/users/cbrnr/following{/other_user}","gists_url":"https://api.github.com/users/cbrnr/gists{/gist_id}","starred_url":"https://api.github.com/users/cbrnr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cbrnr/subscriptions","organizations_url":"https://api.github.com/users/cbrnr/orgs","repos_url":"https://api.github.com/users/cbrnr/repos","events_url":"https://api.github.com/users/cbrnr/events{/privacy}","received_events_url":"https://api.github.com/users/cbrnr/received_events","type":"User","site_admin":false},"body":"We should probably also issue a warning if a custom `stat_fun` is used in combination with `threshold=None`.","created_at":"2017-11-08T19:34:13Z","updated_at":"2017-11-08T19:34:13Z","html_url":"https://github.com/mne-tools/mne-python/pull/4743#discussion_r149773887","pull_request_url":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/mne-tools/mne-python/pulls/comments/149773887"},"html":{"href":"https://github.com/mne-tools/mne-python/pull/4743#discussion_r149773887"},"pull_request":{"href":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743"}},"in_reply_to_id":149773333},"pull_request":{"url":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743","id":151446032,"html_url":"https://github.com/mne-tools/mne-python/pull/4743","diff_url":"https://github.com/mne-tools/mne-python/pull/4743.diff","patch_url":"https://github.com/mne-tools/mne-python/pull/4743.patch","issue_url":"https://api.github.com/repos/mne-tools/mne-python/issues/4743","number":4743,"state":"open","locked":false,"title":"WIP: Better docstring for clustering","user":{"login":"larsoner","id":2365790,"avatar_url":"https://avatars1.githubusercontent.com/u/2365790?v=4","gravatar_id":"","url":"https://api.github.com/users/larsoner","html_url":"https://github.com/larsoner","followers_url":"https://api.github.com/users/larsoner/followers","following_url":"https://api.github.com/users/larsoner/following{/other_user}","gists_url":"https://api.github.com/users/larsoner/gists{/gist_id}","starred_url":"https://api.github.com/users/larsoner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/larsoner/subscriptions","organizations_url":"https://api.github.com/users/larsoner/orgs","repos_url":"https://api.github.com/users/larsoner/repos","events_url":"https://api.github.com/users/larsoner/events{/privacy}","received_events_url":"https://api.github.com/users/larsoner/received_events","type":"User","site_admin":false},"body":"@cbrnr @agramfort can you look and see if you're happy with this wording? If so I'll update the other clustering functions, too.\r\n\r\n- [ ] update all clustering functions\r\n- [ ] modernize the cluster stats method doc a bit","created_at":"2017-11-08T17:27:38Z","updated_at":"2017-11-08T19:34:13Z","closed_at":null,"merged_at":null,"merge_commit_sha":"bfc7977d3806a5d39e84f03d5b28c3a1598c67d2","assignee":null,"assignees":[],"requested_reviewers":[],"milestone":null,"commits_url":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743/commits","review_comments_url":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743/comments","review_comment_url":"https://api.github.com/repos/mne-tools/mne-python/pulls/comments{/number}","comments_url":"https://api.github.com/repos/mne-tools/mne-python/issues/4743/comments","statuses_url":"https://api.github.com/repos/mne-tools/mne-python/statuses/151857f9c0ec6635171359d10c00ef474dd43bbd","head":{"label":"larsoner:cluster-doc","ref":"cluster-doc","sha":"151857f9c0ec6635171359d10c00ef474dd43bbd","user":{"login":"larsoner","id":2365790,"avatar_url":"https://avatars1.githubusercontent.com/u/2365790?v=4","gravatar_id":"","url":"https://api.github.com/users/larsoner","html_url":"https://github.com/larsoner","followers_url":"https://api.github.com/users/larsoner/followers","following_url":"https://api.github.com/users/larsoner/following{/other_user}","gists_url":"https://api.github.com/users/larsoner/gists{/gist_id}","starred_url":"https://api.github.com/users/larsoner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/larsoner/subscriptions","organizations_url":"https://api.github.com/users/larsoner/orgs","repos_url":"https://api.github.com/users/larsoner/repos","events_url":"https://api.github.com/users/larsoner/events{/privacy}","received_events_url":"https://api.github.com/users/larsoner/received_events","type":"User","site_admin":false},"repo":{"id":5848067,"name":"mne-python","full_name":"larsoner/mne-python","owner":{"login":"larsoner","id":2365790,"avatar_url":"https://avatars1.githubusercontent.com/u/2365790?v=4","gravatar_id":"","url":"https://api.github.com/users/larsoner","html_url":"https://github.com/larsoner","followers_url":"https://api.github.com/users/larsoner/followers","following_url":"https://api.github.com/users/larsoner/following{/other_user}","gists_url":"https://api.github.com/users/larsoner/gists{/gist_id}","starred_url":"https://api.github.com/users/larsoner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/larsoner/subscriptions","organizations_url":"https://api.github.com/users/larsoner/orgs","repos_url":"https://api.github.com/users/larsoner/repos","events_url":"https://api.github.com/users/larsoner/events{/privacy}","received_events_url":"https://api.github.com/users/larsoner/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/larsoner/mne-python","description":"MNE scripting with Python","fork":true,"url":"https://api.github.com/repos/larsoner/mne-python","forks_url":"https://api.github.com/repos/larsoner/mne-python/forks","keys_url":"https://api.github.com/repos/larsoner/mne-python/keys{/key_id}","collaborators_url":"https://api.github.com/repos/larsoner/mne-python/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/larsoner/mne-python/teams","hooks_url":"https://api.github.com/repos/larsoner/mne-python/hooks","issue_events_url":"https://api.github.com/repos/larsoner/mne-python/issues/events{/number}","events_url":"https://api.github.com/repos/larsoner/mne-python/events","assignees_url":"https://api.github.com/repos/larsoner/mne-python/assignees{/user}","branches_url":"https://api.github.com/repos/larsoner/mne-python/branches{/branch}","tags_url":"https://api.github.com/repos/larsoner/mne-python/tags","blobs_url":"https://api.github.com/repos/larsoner/mne-python/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/larsoner/mne-python/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/larsoner/mne-python/git/refs{/sha}","trees_url":"https://api.github.com/repos/larsoner/mne-python/git/trees{/sha}","statuses_url":"https://api.github.com/repos/larsoner/mne-python/statuses/{sha}","languages_url":"https://api.github.com/repos/larsoner/mne-python/languages","stargazers_url":"https://api.github.com/repos/larsoner/mne-python/stargazers","contributors_url":"https://api.github.com/repos/larsoner/mne-python/contributors","subscribers_url":"https://api.github.com/repos/larsoner/mne-python/subscribers","subscription_url":"https://api.github.com/repos/larsoner/mne-python/subscription","commits_url":"https://api.github.com/repos/larsoner/mne-python/commits{/sha}","git_commits_url":"https://api.github.com/repos/larsoner/mne-python/git/commits{/sha}","comments_url":"https://api.github.com/repos/larsoner/mne-python/comments{/number}","issue_comment_url":"https://api.github.com/repos/larsoner/mne-python/issues/comments{/number}","contents_url":"https://api.github.com/repos/larsoner/mne-python/contents/{+path}","compare_url":"https://api.github.com/repos/larsoner/mne-python/compare/{base}...{head}","merges_url":"https://api.github.com/repos/larsoner/mne-python/merges","archive_url":"https://api.github.com/repos/larsoner/mne-python/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/larsoner/mne-python/downloads","issues_url":"https://api.github.com/repos/larsoner/mne-python/issues{/number}","pulls_url":"https://api.github.com/repos/larsoner/mne-python/pulls{/number}","milestones_url":"https://api.github.com/repos/larsoner/mne-python/milestones{/number}","notifications_url":"https://api.github.com/repos/larsoner/mne-python/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/larsoner/mne-python/labels{/name}","releases_url":"https://api.github.com/repos/larsoner/mne-python/releases{/id}","deployments_url":"https://api.github.com/repos/larsoner/mne-python/deployments","created_at":"2012-09-17T22:08:11Z","updated_at":"2015-05-07T15:05:01Z","pushed_at":"2017-11-08T18:21:08Z","git_url":"git://github.com/larsoner/mne-python.git","ssh_url":"git@github.com:larsoner/mne-python.git","clone_url":"https://github.com/larsoner/mne-python.git","svn_url":"https://github.com/larsoner/mne-python","homepage":"http://martinos.org/mne/","size":96715,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"archived":false,"open_issues_count":0,"forks":2,"open_issues":0,"watchers":1,"default_branch":"master"}},"base":{"label":"mne-tools:master","ref":"master","sha":"73806bc0b00accd99bb2209c9d406dc11ab94bc4","user":{"login":"mne-tools","id":583875,"avatar_url":"https://avatars3.githubusercontent.com/u/583875?v=4","gravatar_id":"","url":"https://api.github.com/users/mne-tools","html_url":"https://github.com/mne-tools","followers_url":"https://api.github.com/users/mne-tools/followers","following_url":"https://api.github.com/users/mne-tools/following{/other_user}","gists_url":"https://api.github.com/users/mne-tools/gists{/gist_id}","starred_url":"https://api.github.com/users/mne-tools/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mne-tools/subscriptions","organizations_url":"https://api.github.com/users/mne-tools/orgs","repos_url":"https://api.github.com/users/mne-tools/repos","events_url":"https://api.github.com/users/mne-tools/events{/privacy}","received_events_url":"https://api.github.com/users/mne-tools/received_events","type":"Organization","site_admin":false},"repo":{"id":1301584,"name":"mne-python","full_name":"mne-tools/mne-python","owner":{"login":"mne-tools","id":583875,"avatar_url":"https://avatars3.githubusercontent.com/u/583875?v=4","gravatar_id":"","url":"https://api.github.com/users/mne-tools","html_url":"https://github.com/mne-tools","followers_url":"https://api.github.com/users/mne-tools/followers","following_url":"https://api.github.com/users/mne-tools/following{/other_user}","gists_url":"https://api.github.com/users/mne-tools/gists{/gist_id}","starred_url":"https://api.github.com/users/mne-tools/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mne-tools/subscriptions","organizations_url":"https://api.github.com/users/mne-tools/orgs","repos_url":"https://api.github.com/users/mne-tools/repos","events_url":"https://api.github.com/users/mne-tools/events{/privacy}","received_events_url":"https://api.github.com/users/mne-tools/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mne-tools/mne-python","description":"MNE : Magnetoencephalography (MEG) and Electroencephalography (EEG) in Python","fork":false,"url":"https://api.github.com/repos/mne-tools/mne-python","forks_url":"https://api.github.com/repos/mne-tools/mne-python/forks","keys_url":"https://api.github.com/repos/mne-tools/mne-python/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mne-tools/mne-python/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mne-tools/mne-python/teams","hooks_url":"https://api.github.com/repos/mne-tools/mne-python/hooks","issue_events_url":"https://api.github.com/repos/mne-tools/mne-python/issues/events{/number}","events_url":"https://api.github.com/repos/mne-tools/mne-python/events","assignees_url":"https://api.github.com/repos/mne-tools/mne-python/assignees{/user}","branches_url":"https://api.github.com/repos/mne-tools/mne-python/branches{/branch}","tags_url":"https://api.github.com/repos/mne-tools/mne-python/tags","blobs_url":"https://api.github.com/repos/mne-tools/mne-python/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mne-tools/mne-python/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mne-tools/mne-python/git/refs{/sha}","trees_url":"https://api.github.com/repos/mne-tools/mne-python/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mne-tools/mne-python/statuses/{sha}","languages_url":"https://api.github.com/repos/mne-tools/mne-python/languages","stargazers_url":"https://api.github.com/repos/mne-tools/mne-python/stargazers","contributors_url":"https://api.github.com/repos/mne-tools/mne-python/contributors","subscribers_url":"https://api.github.com/repos/mne-tools/mne-python/subscribers","subscription_url":"https://api.github.com/repos/mne-tools/mne-python/subscription","commits_url":"https://api.github.com/repos/mne-tools/mne-python/commits{/sha}","git_commits_url":"https://api.github.com/repos/mne-tools/mne-python/git/commits{/sha}","comments_url":"https://api.github.com/repos/mne-tools/mne-python/comments{/number}","issue_comment_url":"https://api.github.com/repos/mne-tools/mne-python/issues/comments{/number}","contents_url":"https://api.github.com/repos/mne-tools/mne-python/contents/{+path}","compare_url":"https://api.github.com/repos/mne-tools/mne-python/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mne-tools/mne-python/merges","archive_url":"https://api.github.com/repos/mne-tools/mne-python/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mne-tools/mne-python/downloads","issues_url":"https://api.github.com/repos/mne-tools/mne-python/issues{/number}","pulls_url":"https://api.github.com/repos/mne-tools/mne-python/pulls{/number}","milestones_url":"https://api.github.com/repos/mne-tools/mne-python/milestones{/number}","notifications_url":"https://api.github.com/repos/mne-tools/mne-python/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mne-tools/mne-python/labels{/name}","releases_url":"https://api.github.com/repos/mne-tools/mne-python/releases{/id}","deployments_url":"https://api.github.com/repos/mne-tools/mne-python/deployments","created_at":"2011-01-28T03:31:13Z","updated_at":"2017-11-07T07:17:45Z","pushed_at":"2017-11-08T18:23:37Z","git_url":"git://github.com/mne-tools/mne-python.git","ssh_url":"git@github.com:mne-tools/mne-python.git","clone_url":"https://github.com/mne-tools/mne-python.git","svn_url":"https://github.com/mne-tools/mne-python","homepage":"http://martinos.org/mne/","size":96880,"stargazers_count":357,"watchers_count":357,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":324,"mirror_url":null,"archived":false,"open_issues_count":227,"forks":324,"open_issues":227,"watchers":357,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743"},"html":{"href":"https://github.com/mne-tools/mne-python/pull/4743"},"issue":{"href":"https://api.github.com/repos/mne-tools/mne-python/issues/4743"},"comments":{"href":"https://api.github.com/repos/mne-tools/mne-python/issues/4743/comments"},"review_comments":{"href":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743/comments"},"review_comment":{"href":"https://api.github.com/repos/mne-tools/mne-python/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/mne-tools/mne-python/pulls/4743/commits"},"statuses":{"href":"https://api.github.com/repos/mne-tools/mne-python/statuses/151857f9c0ec6635171359d10c00ef474dd43bbd"}},"author_association":"OWNER"}}
{"actor":{"display_login":"cbrnr"}}