.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH PYMVPA2-DESCRIBE "1" "April 2017" "pymvpa2-describe 2.6.1" "User Commands"
.SH NAME
pymvpa2-describe \-  describe a dataset's content
.SH SYNOPSIS
.B pymvpa2
\fI\,describe \/\fR[\fI\,--version\/\fR] [\fI\,-h\/\fR] \fI\,-i DATASET \/\fR[\fI\,DATASET \/\fR...] [\fI\,-r {txtsummary,sample_histogram}\/\fR] [\fI\,--numpy-xfm SPEC\/\fR] [\fI\,--figure-title FIGURE_TITLE\/\fR] [\fI\,--histogram-bins VALUE\/\fR] [\fI\,--xlim XLIM XLIM\/\fR] [\fI\,--ylim YLIM YLIM\/\fR] [\fI\,--x-marker X_MARKER \/\fR[\fI\,X_MARKER \/\fR...]] [\fI\,--y-marker Y_MARKER \/\fR[\fI\,Y_MARKER \/\fR...]] [\fI\,--target-attr NAME\/\fR]
.SH DESCRIPTION
Describe a dataset's content
.PP
This command can produce a number of reports for datasets. Currently
supported are summary statistics in text format, as well as basic plots.
See the \fB\-\-report\fR option for more information.
.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\-r\fR {txtsummary,sample_histogram}, \fB\-\-report\fR {txtsummary,sample_histogram}
choose a type of report. Default: terse summary in
text format.
.SS "Options for transforming dataset content before plotting:"
.TP
\fB\-\-numpy\-xfm\fR SPEC
apply a Numpy function along a given axis of the
samples before generating the dataset info summary.
For example, 'samples:std' will apply the 'std'
function along the samples axis, i.e. compute a vector
of standard deviations for all features in a dataset
.SS "Options for plot formatting:"
.TP
\fB\-\-figure\-title\fR FIGURE_TITLE
title for a plot
.TP
\fB\-\-histogram\-bins\fR VALUE
number of bin for histograms
.TP
\fB\-\-xlim\fR XLIM XLIM
minimum and maximum value of the x\-axis extent in a
figure
.TP
\fB\-\-ylim\fR YLIM YLIM
minimum and maximum value of the y\-axis extent in a
figure
.TP
\fB\-\-x\-marker\fR X_MARKER [X_MARKER ...]
list of x\-value to draw markers on in a figure
.TP
\fB\-\-y\-marker\fR Y_MARKER [Y_MARKER ...]
list of y\-value to draw markers on in a figure
.SS "Options for dataset description:"
.TP
\fB\-\-target\-attr\fR NAME
name of a samples attributes defining 'target'. This
information is used to define groups of samples when
generating information on the within and between
category data structure in a dataset.
.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.