staircase.Stairs.describe

Stairs.describe(lower=-inf, upper=inf, percentiles=(25, 50, 75))

Generate descriptive statistics.

Parameters:
  • lower (int, float or pandas.Timestamp) – lower bound of the interval on which to perform the calculation
  • upper (int, float or pandas.Timestamp) – upper bound of the interval on which to perform the calculation
  • percentiles (array-like of float, default [25, 50, 70]) – The percentiles to include in output. Numbers should be in the range 0 to 100.
Returns:

Return type:

pandas.Series

Examples

>>> s2.plot()
../_images/staircase-Stairs-describe-1.png
>>> s2.describe()
unique    3.000000
mean     -0.272727
std       0.686349
min      -1.000000
25%      -1.000000
50%       0.000000
75%       0.500000
max       0.500000
dtype: float64
>>> s2.describe(lower=0, upper=6, percentiles=range(0,101,20))
unique    3.000000
mean     -0.250000
std       0.661438
min      -1.000000
0%       -1.000000
20%      -1.000000
40%      -1.000000
60%       0.000000
80%       0.500000
100%      0.500000
max       0.500000
dtype: float64