.\" Text automatically generated by txt2man
.TH mlpack_preprocess_describe 1 "12 December 2020" "mlpack-3.4.2" "User Commands"
.SH NAME
\fBmlpack_preprocess_describe \fP- descriptive statistics
.SH SYNOPSIS
.nf
.fam C
 \fBmlpack_preprocess_describe\fP \fB-i\fP \fIstring\fP [\fB-d\fP \fIint\fP] [\fB-P\fP \fIbool\fP] [\fB-p\fP \fIint\fP] [\fB-r\fP \fIbool\fP] [\fB-V\fP \fIbool\fP] [\fB-w\fP \fIint\fP] [\fB-h\fP \fB-v\fP] 
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION


This utility takes a dataset and prints out the descriptive statistics of the
data. Descriptive statistics is the discipline of quantitatively describing
the main features of a collection of information, or the quantitative
description itself. The program does not modify the original file, but instead
prints out the statistics to the console. The printed result will look like a
table.
.PP
Optionally, width and precision of the output can be adjusted by a user using
the '\fB--width\fP (\fB-w\fP)' and '\fB--precision\fP (\fB-p\fP)' parameters. A user can also select a
specific dimension to analyze if there are too many dimensions. The
\(cq\fB--population\fP (\fB-P\fP)' parameter can be specified when the dataset should be
considered as a population. Otherwise, the dataset will be considered as a
sample.
.PP
So, a simple example where we want to print out statistical facts about the
dataset 'X.csv' using the default settings, we could run 
.PP
$ \fBmlpack_preprocess_describe\fP \fB--input_file\fP X.csv \fB--verbose\fP
.PP
If we want to customize the width to 10 and precision to 5 and consider the
dataset as a population, we could run
.PP
$ \fBmlpack_preprocess_describe\fP \fB--input_file\fP X.csv \fB--width\fP 10 \fB--precision\fP 5
\fB--verbose\fP
.RE
.PP

.SH REQUIRED INPUT OPTIONS 

.TP
.B
\fB--input_file\fP (\fB-i\fP) [\fIstring\fP]
Matrix containing data,  
.SH OPTIONAL INPUT OPTIONS 

.TP
.B
\fB--dimension\fP (\fB-d\fP) [\fIint\fP]
Dimension of the data. Use this to specify a dimension Default value 0. 
.TP
.B
\fB--help\fP (\fB-h\fP) [\fIbool\fP]
Default help info. 
.TP
.B
\fB--info\fP [\fIstring\fP]
Print help on a specific option. Default value ''. 
.TP
.B
\fB--population\fP (\fB-P\fP) [\fIbool\fP]
If specified, the program will calculate statistics assuming the dataset is the population. By default, the program will assume the dataset as a sample. 
.TP
.B
\fB--precision\fP (\fB-p\fP) [\fIint\fP]
Precision of the output statistics. Default value 4. 
.TP
.B
\fB--row_major\fP (\fB-r\fP) [\fIbool\fP]
If specified, the program will calculate statistics across rows, not across columns.  (Remember that in mlpack, a column represents a point, so this option is generally not necessary.) 
.TP
.B
\fB--verbose\fP (\fB-v\fP) [\fIbool\fP]
Display informational messages and the full list of parameters and timers at the end of execution. 
.TP
.B
\fB--version\fP (\fB-V\fP) [\fIbool\fP]
Display the version of mlpack. 
.TP
.B
\fB--width\fP (\fB-w\fP) [\fIint\fP]
Width of the output table. Default value 8.
.SH ADDITIONAL INFORMATION

For further information, including relevant papers, citations, and theory,
consult the documentation found at http://www.mlpack.org or included with your
distribution of mlpack.