summarize()

Compute summary statistics for a sequence of numbers.

Usage

Source

summarize(values)

Missing values (None and NaN) are dropped with a warning.

Parameters

values: Sequence[float | None]

The numbers to summarize.

Returns

SummaryResult

The count, mean, standard deviation (with n - 1 denominator), minimum and maximum.

Examples

Summarize a list of numbers:

from tinytab import summarize

result = summarize([3.5, 2.25, 4.0, 1.75])
result

SummaryResult(n=4, mean=2.875, sd=1.051, min=1.75, max=4)

Each statistic is an attribute of the result:

result.mean

2.875