.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CSVSTAT "1" "March 2023" "csvstat 1.1.1" "User Commands"
.SH NAME
csvstat \- manual page for csvstat 1.1.1
.SH DESCRIPTION
usage: csvstat [\-h] [\-d DELIMITER] [\-t] [\-q QUOTECHAR] [\-u {0,1,2,3}] [\-b]
.IP
[\-p ESCAPECHAR] [\-z FIELD_SIZE_LIMIT] [\-e ENCODING] [\-S] [\-H]
[\-K SKIP_LINES] [\-v] [\-l] [\-\-zero] [\-V] [\-\-csv] [\-n]
[\-c COLUMNS] [\-\-type] [\-\-nulls] [\-\-unique] [\-\-min] [\-\-max]
[\-\-sum] [\-\-mean] [\-\-median] [\-\-stdev] [\-\-len] [\-\-freq]
[\-\-freq\-count FREQ_COUNT] [\-\-count]
[\-\-decimal\-format DECIMAL_FORMAT] [\-G] [\-y SNIFF_LIMIT]
[FILE]
.PP
Print descriptive statistics for each column in a CSV file.
.SS "positional arguments:"
.TP
FILE
The CSV file to operate on. If omitted, will accept
input as piped data via STDIN.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-d\fR DELIMITER, \fB\-\-delimiter\fR DELIMITER
Delimiting character of the input CSV file.
.TP
\fB\-t\fR, \fB\-\-tabs\fR
Specify that the input CSV file is delimited with
tabs. Overrides "\-d".
.TP
\fB\-q\fR QUOTECHAR, \fB\-\-quotechar\fR QUOTECHAR
Character used to quote strings in the input CSV file.
.TP
\fB\-u\fR {0,1,2,3}, \fB\-\-quoting\fR {0,1,2,3}
Quoting style used in the input CSV file. 0 = Quote
Minimal, 1 = Quote All, 2 = Quote Non\-numeric, 3 =
Quote None.
.TP
\fB\-b\fR, \fB\-\-no\-doublequote\fR
Whether or not double quotes are doubled in the input
CSV file.
.TP
\fB\-p\fR ESCAPECHAR, \fB\-\-escapechar\fR ESCAPECHAR
Character used to escape the delimiter if \fB\-\-quoting\fR 3
("Quote None") is specified and to escape the
QUOTECHAR if \fB\-\-no\-doublequote\fR is specified.
.TP
\fB\-z\fR FIELD_SIZE_LIMIT, \fB\-\-maxfieldsize\fR FIELD_SIZE_LIMIT
Maximum length of a single field in the input CSV
file.
.TP
\fB\-e\fR ENCODING, \fB\-\-encoding\fR ENCODING
Specify the encoding of the input CSV file.
.TP
\fB\-S\fR, \fB\-\-skipinitialspace\fR
Ignore whitespace immediately following the delimiter.
.TP
\fB\-H\fR, \fB\-\-no\-header\-row\fR
Specify that the input CSV file has no header row.
Will create default headers (a,b,c,...).
.TP
\fB\-K\fR SKIP_LINES, \fB\-\-skip\-lines\fR SKIP_LINES
Specify the number of initial lines to skip before the
header row (e.g. comments, copyright notices, empty
rows).
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print detailed tracebacks when errors occur.
.TP
\fB\-l\fR, \fB\-\-linenumbers\fR
Insert a column of line numbers at the front of the
output. Useful when piping to grep or as a simple
primary key.
.TP
\fB\-\-zero\fR
When interpreting or displaying column numbers, use
zero\-based numbering instead of the default 1\-based
numbering.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.
.TP
\fB\-\-csv\fR
Output results as a CSV, rather than text.
.TP
\fB\-n\fR, \fB\-\-names\fR
Display column names and indices from the input CSV
and exit.
.TP
\fB\-c\fR COLUMNS, \fB\-\-columns\fR COLUMNS
A comma\-separated list of column indices, names or
ranges to be examined, e.g. "1,id,3\-5". Defaults to
all columns.
.TP
\fB\-\-type\fR
Only output data type.
.TP
\fB\-\-nulls\fR
Only output whether columns contains nulls.
.TP
\fB\-\-unique\fR
Only output counts of unique values.
.TP
\fB\-\-min\fR
Only output smallest values.
.TP
\fB\-\-max\fR
Only output largest values.
.TP
\fB\-\-sum\fR
Only output sums.
.TP
\fB\-\-mean\fR
Only output means.
.TP
\fB\-\-median\fR
Only output medians.
.TP
\fB\-\-stdev\fR
Only output standard deviations.
.TP
\fB\-\-len\fR
Only output the length of the longest values.
.TP
\fB\-\-freq\fR
Only output lists of frequent values.
.TP
\fB\-\-freq\-count\fR FREQ_COUNT
The maximum number of frequent values to display.
.TP
\fB\-\-count\fR
Only output total row count.
.TP
\fB\-\-decimal\-format\fR DECIMAL_FORMAT
%\-format specification for printing decimal numbers.
Defaults to locale\-specific formatting with "%.3f".
.TP
\fB\-G\fR, \fB\-\-no\-grouping\-separator\fR
Do not use grouping separators in decimal numbers.
.TP
\fB\-y\fR SNIFF_LIMIT, \fB\-\-snifflimit\fR SNIFF_LIMIT
Limit CSV dialect sniffing to the specified number of
bytes. Specify "0" to disable sniffing entirely, or
"\-1" to sniff the entire file.
.SH "SEE ALSO"
The full documentation for
.B csvstat
is maintained as a Texinfo manual.  If the
.B info
and
.B csvstat
programs are properly installed at your site, the command
.IP
.B info csvstat
.PP
should give you access to the complete manual.