stats

README

stats-tools

A set of command-line statistics tools.

Installation

Download the binaries and put them somewhere in your path.

From source

git clone git://github.com/jweslley/stats-tools.git
cd stats-tools
make

Utilities

• min - Calculate the minimum of a number sequence
• max - Calculate the maximum of a number sequence
• mean - Calculate the mean of a number sequence
• std - Calculate the standard deviation of a number sequence
• var - Calculate the variance of a number sequence
• sum - Calculate the sum of a number sequence
• stats - Output a summary table including mean, median, mininum, maximum, standard deviation, variance and number count of a number sequence

Usage

All utilities take as input a file in table format to perform some calculation based on it. A tipical input file is shown below:

1 2 4
3 5 4
6 4 6
4 5 6
9 12 16

Considering this input file, let's call it example1.dat, you can calculate some statistics like:

The max value on the first column:

max example1.dat

The min value on the second column:

min -c 2 example1.dat

If the input file's columns are separated by another character instead of whitespace characters, like CSV files, you can use the -s option to denote this. The next example outputs a statistical summary about the second column of the following file (example2.dat):

"A",10,12
"A",11,14
"B",5,8
"B",6,10
"A",10.5,13
"B",7,11

Calculating the summary:

stats -c 2 -s , example2.dat

Commonly, data files may contain a head, i.e., the first line describes the columns, something like the example3.dat file showed below:

Year,Make,Model,Description,Price
1997,Ford,E350,"ac abs moon",3000.00
1999,Chevy,"Venture ""Extended Edition""","",4900.00
1999,Chevy,"Venture ""Extended Edition, Very Large""","",5000.00
1996,Jeep,Grand Cherokee,"MUST SELL!air, moon roof, loaded",4799.00

The -b option remove the first line from calculations. In this case, the mean price of the cars is given by:

mean -b -s, -c5 test/example3.dat

Piping data

All stats-tools read data from standard input if no file is passed to them. The following command calculates the max value on the second column containing the word bar in the file foo.dat:

grep bar foo.dat | max -c 2

Bugs and Feedback

If you discover any bugs or have some idea, feel free to create an issue on GitHub:

http://github.com/jweslley/stats-tools/issues

License

MIT license. Copyright (c) 2011 Jonhnny Weslley http://jonhnnyweslley.net

See the LICENSE file provided with the source distribution for full details.

Documentation

Index

• func Tool(desc string, outputter func(s *Stats))
• type Stats
  • func NewStats() *Stats
  • func (s *Stats) Count() int64
  • func (s *Stats) Max() float64
  • func (s *Stats) Mean() float64
  • func (s *Stats) Min() float64
  • func (s *Stats) StdDev() float64
  • func (s *Stats) Sum() float64
  • func (s *Stats) Update(v float64)
  • func (s *Stats) Variance() float64

Functions

func Tool

func Tool(desc string, outputter func(s *Stats))

Types

type Stats

type Stats struct {
	// contains filtered or unexported fields
}

func NewStats

func NewStats() *Stats

func (*Stats) Count

func (s *Stats) Count() int64

func (*Stats) Max

func (s *Stats) Max() float64

func (*Stats) Mean

func (s *Stats) Mean() float64

func (*Stats) Min

func (s *Stats) Min() float64

func (*Stats) StdDev

func (s *Stats) StdDev() float64

func (*Stats) Sum

func (s *Stats) Sum() float64

func (*Stats) Update

func (s *Stats) Update(v float64)

func (*Stats) Variance

func (s *Stats) Variance() float64