aboutsummaryrefslogtreecommitdiff
path: root/vendor/voclient/doc/votstat.man
blob: ab9532c826c8d49c5b306b019d504b6874fce0ce (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
." @(#)votstat.1 1.0 Feb-2013 MJF
.TH VOTSTAT 1 "Feb 2013" "VOClient Package"
.SH NAME
votstat \- Compute statistics for numeric columns of a VOTable.

.SH SYNOPSIS
\fBvotstat\fP [\fI-opts\fP] votable.xml

.SH OPTIONS
The \fIvotstat\fP task accepts the following options:
.TP 6
.B \-h, --help
Print a help summary to the terminal and exit.  No processing is done 
following this flag.

.TP 6
.B \-a,--all
Print all columns, but only compute statistics for the numeric columns.
.TP 6
.B \-o \fINAME\fP,--output \fINAME\fP
Output name of sorted file, if not specified results are written to stdout.
.TP 6
.B \-n,--noheader
Suppress header information for formats other than XML and FITS.


.SH DESCRIPTION
The \fIvotstat\fP task is used to compute statistics for columns of a table.
Output is written to the stdout unless the \fI-o\fP flag is used to 
name a specific output file.  If the \fI-a\fP flag is used, all columns 
are printed but only the statistics of numeric columns is computed.

If no input file is specified the VOTable will be read from the stdin,
results will be written to stdout unless the \fI\-o\fP (or \fI\--output\fP)
names an output file.  The task will only process a single VOTable and may
not be used to convert multiple files in a single call.

.SH RETURN STATUS
On exit the \fBvotstat\fP task will return a zero indicating success, or a 
one indicating an error.

.SH EXAMPLES
.TP 4
1) Print statistics for a VOTable

.nf
  % votstat test.xml
.fi

.TP 4
2) Print statistics for all column in a VOTable and save results to a file.

.nf
  % votsort -a -o stats test.xml
.fi

.SH BUGS
The task should have a way to select specific columns or request specific
values.
.SH Revision History
Feb 2013 - First public release
.SH Author
Michael Fitzpatrick (fitz@noao.edu), Feb 2013
.SH "SEE ALSO"
votget, votinfo, votcnv, votpos, votstat