2 .\" Copyright (c) 2007 Poul-Henning Kamp
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd statistics utility
38 .Op Fl c Ar confidence_level
45 command calculates fundamental statistical properties of numeric data
46 in the specified files or, if no file is specified, standard input.
48 The options are as follows:
51 Just report the statistics of the input and relative comparisons,
52 suppress the ASCII-art plot.
54 Just report the raw statistics of the input, suppress the ASCII-art plot
55 and the relative comparisons.
57 Suppress printing of summary statistics and data-set names; typically for use
61 Print the average/median/stddev bars on separate lines in the ASCII-art
62 plot, to avoid overlap.
64 Specify which column of data to use.
65 By default the first column in the input file(s) are used.
66 .It Fl c Ar confidence_level
67 Specify desired confidence level for Student's T analysis.
68 Possible values are 80, 90, 95, 98, 99 and 99.5 %
70 Specifies the column delimiter characters, default is SPACE and TAB.
75 Width of ASCII-art plot in characters.
76 The default is the terminal width, or 74 if standard output is not a
80 A sample output could look like this:
81 .Bd -literal -offset indent
82 $ ministat -s -w 60 iguana chameleon
85 +------------------------------------------------------------+
87 | |________M______A_______________| |
88 | |________________M__A___________________| |
89 +------------------------------------------------------------+
90 N Min Max Median Avg Stddev
91 x 7 50 750 200 300 238.04761
92 + 5 150 930 500 540 299.08193
93 No difference proven at 95.0% confidence
98 tells you, as in the example above, that there is no difference
99 proven at 95% confidence, the two data sets you gave it are for
100 all statistical purposes identical.
102 You have the option of lowering your standards by specifying a
103 lower confidence level:
104 .Bd -literal -offset indent
105 $ ministat -s -w 60 -c 80 iguana chameleon
108 +------------------------------------------------------------+
110 | |________M______A_______________| |
111 | |________________M__A___________________| |
112 +------------------------------------------------------------+
113 N Min Max Median Avg Stddev
114 x 7 50 750 200 300 238.04761
115 + 5 150 930 500 540 299.08193
116 Difference at 80.0% confidence
119 (Student's t, pooled s = 264.159)
122 But a lower standard does not make your data any better, and the
123 example is only included here to show the format of the output when
124 a statistical difference is proven according to Student's T method.
126 Any mathematics text on basic statistics, for instances Larry Gonicks
127 excellent "Cartoon Guide to Statistics" which supplied the above example.
131 command was written by Poul-Henning Kamp out of frustration
132 over all the bogus benchmark claims made by people with no
133 understanding of the importance of uncertainty and statistics.
137 it has lived in the source tree as a developer tool, graduating
138 to the installed system from