API reference#

Atkinson Inequality Measures#

atkinson.Atkinson(y, epsilon)

A class to calculate and store the Atkinson index and the equally distributed equivalent (EDE).

Gini Inequality Measures#

gini.Gini(x)

Classic Gini coefficient in absolute deviation form.

gini.Gini_Spatial(x, w[, permutations])

Spatial Gini coefficient.

Schutz Inequality Measures#

schutz.Schutz(df, column_name)

The Schutz class calculates measures of inequality in an income distribution.

Theil Inequality Measures#

theil.Theil(y)

Classic Theil measure of inequality.

theil.TheilD(y, partition)

Decomposition of Theil's T based on partitioning of observations into exhaustive and mutually exclusive groups.

theil.TheilDSim(y, partition[, permutations])

Random permutation based inference on Theil's inequality decomposition.

Wolfson Bipolarization Measure#

wolfson.wolfson(data)

Calculate the Wolfson Bipolarization Index for a given income distribution.

Pengram#

pen.pen(df, col, x[, weight, ascending, ...])

Creates the Pen's Parade visualization.

pen.pengram(gdf, col, name[, figsize, k, ...])

Pen's Parade combined with a choropleth map.