PyDocs

Numeric and Mathematical Modules

statistics

Basic statistics module.

This module provides functions for calculating statistics of data, including
averages, variance, and standard deviation.

Calculating averages
--------------------

==================  ==================================================
Function            Description
==================  ==================================================
mean                Arithmetic mean (average) of data.
fmean               Fast, floating-point arithmetic mean.
geometric_mean      Geometric mean of data.
harmonic_mean       Harmonic mean of data.
median              Median (middle value) of data.
median_low          Low median of data.
median_high         High median of data.
median_grouped      Median, or 50th percentile, of grouped data.
mode                Mode (most common value) of data.
multimode           List of modes (most common values of data).
quantiles           Divide data into intervals with equal probability.
==================  ==================================================

Calculate the arithmetic mean ("the average") of data:

>>> mean([-1.0, 2.5, 3.25, 5.75])
2.625


Calculate the standard median of discrete data:

>>> median([2, 3, 4, 5])
3.5


Calculate the median, or 50th percentile, of data grouped into class intervals
centred on the data values provided. E.g. if your data points are rounded to
the nearest whole number:

>>> median_grouped([2, 2, 3, 3, 3, 4])  #doctest: +ELLIPSIS
2.8333333333...

This should be interpreted in this way: you have two data points in the class
interval 1.5-2.5, three data points in the class interval 2.5-3.5, and one in
the class interval 3.5-4.5. The median of these data points is 2.8333...


Calculating variability or spread
---------------------------------

==================  =============================================
Function            Description
==================  =============================================
pvariance           Population variance of data.
variance            Sample variance of data.
pstdev              Population standard deviation of data.
stdev               Sample standard deviation of data.
==================  =============================================

Calculate the standard deviation of sample data:

>>> stdev([2.5, 3.25, 5.5, 11.25, 11.75])  #doctest: +ELLIPSIS
4.38961843444...

If you have previously calculated the mean, you can pass it as the optional
second argument to the four "spread" functions to avoid recalculating it:

>>> data = [1, 2, 2, 4, 4, 4, 5, 6]
>>> mu = mean(data)
>>> pvariance(data, mu)
2.5


Statistics for relations between two inputs
-------------------------------------------

==================  ====================================================
Function            Description
==================  ====================================================
covariance          Sample covariance for two variables.
correlation         Pearson's correlation coefficient for two variables.
linear_regression   Intercept and slope for simple linear regression.
==================  ====================================================

Calculate covariance, Pearson's correlation, and simple linear regression
for two inputs:

>>> x = [1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> y = [1, 2, 3, 1, 2, 3, 1, 2, 3]
>>> covariance(x, y)
0.75
>>> correlation(x, y)  #doctest: +ELLIPSIS
0.31622776601...
>>> linear_regression(x, y)  #doctest:
LinearRegression(slope=0.1, intercept=1.5)


Exceptions
----------

A single exception is defined: StatisticsError is a subclass of ValueError.
Symbols in statistics

c

correlation
Pearson's correlation coefficient
covariance
Covariance

f

fmean
Convert data to floats and compute the arithmetic mean.

g

geometric_mean
Convert data to floats and compute the geometric mean.

h

harmonic_mean
Return the harmonic mean of data.

k

kde
Kernel Density Estimation: Create a continuous probability density function or cumulative distribution function from discrete samples.
kde_random
Return a function that makes a random selection from the estimated probability density function created by kde(data, h, kernel).

l

linear_regression
Slope and intercept for simple linear regression.

m

mean
Return the sample arithmetic mean of data.
median
Return the median (middle value) of numeric data.
median_grouped
Estimates the median for numeric data binned around the midpoints of consecutive, fixed-width intervals.
median_high
Return the high median of data.
median_low
Return the low median of numeric data.
mode
Return the most common data point from discrete or nominal data.
multimode
Return a list of the most frequently occurring values.

n

NormalDist
Normal distribution of a random variable

p

pstdev
Return the square root of the population variance.
pvariance
Return the population variance of ``data``.

q

quantiles
Divide *data* into *n* continuous intervals with equal probability.

s

StatisticsError
Subclass of ValueError for statistics-related exceptions.
stdev
Return the square root of the sample variance.

v

variance
Return the sample variance of data.