.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH PYMVPA2-TTEST "1" "August 2016" "pymvpa2-ttest 2.6.0" "User Commands"
.SH NAME
pymvpa2-ttest \-  simple t-test routine
.SH SYNOPSIS
.B pymvpa2
\fI\,ttest \/\fR[\fI\,--version\/\fR] [\fI\,-h\/\fR] \fI\,-i DATASET \/\fR[\fI\,DATASET \/\fR...] [\fI\,-m MASK\/\fR] \fI\,-o OUTPUT \/\fR[\fI\,-c CHANCE_LEVEL\/\fR] [\fI\,-s {t,z,p}\/\fR] [\fI\,-a {greater,less,two-sided}\/\fR] [\fI\,--isample ISAMPLE\/\fR] \fI\,t-test across multiple volumes against some chance level\/\fR
.SH DESCRIPTION
This is a rudimentary way to perform fixed\-effect significance test
across subjects on e.g. searchlight results maps.
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version and license information and
exit
.TP
\fB\-h\fR, \fB\-\-help\fR, \fB\-\-help\-np\fR
show this help message and exit. \fB\-\-help\-np\fR forcefully
disables the use of a pager for displaying the help.
.TP
\fB\-i\fR DATASET [DATASET ...], \fB\-\-input\fR DATASET [DATASET ...]
path(s) to one or more PyMVPA dataset files. All
datasets will be merged into a single dataset
(vstack'ed) in order of specification. In some cases
this option may need to be specified more than once if
multiple, but separate, input datasets are required.
.TP
\fB\-m\fR MASK, \fB\-\-mask\fR MASK
single mask item
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output filename ('.hdf5' extension is added
automatically if necessary).
.TP
\fB\-c\fR CHANCE_LEVEL, \fB\-\-chance\-level\fR CHANCE_LEVEL
chance level performance
.TP
\fB\-s\fR {t,z,p}, \fB\-\-stat\fR {t,z,p}
Store corresponding statistic, e.g. z\-value
corresponding to the original t\-value
.TP
\fB\-a\fR {greater,less,two\-sided}, \fB\-\-alternative\fR {greater,less,two\-sided}
Which tail of the distribution 'interesting' values
belong to. E.g. if values are accuracies, it would be
the 'greater', if errors \fB\-\-\fR the 'less'
.TP
\fB\-\-isample\fR ISAMPLE
In case of multi sample dataset, which sample to
extract to run the ttest on
.SH AUTHOR
Written by Michael Hanke & Yaroslav Halchenko, and numerous other contributors.
.SH COPYRIGHT
Copyright \(co 2006\-2016 PyMVPA developers
.PP
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
.PP
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
.PP
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.