segregation.batch.batch_compute_singlegroup

segregation.batch.batch_compute_singlegroup(gdf, group_pop_var, total_pop_var, progress_bar=True, **kwargs)

Batch compute single-group indices.

Parameters:

gdfDataFrame or GeoDataFrame

DataFrame holding demographic data for study region

group_pop_varstr

The name of variable in data that contains the population size of the group of interest

total_pop_varstr

Variable in data that contains the total population count of the unit

progress_bar: bool

Whether to show a progress bar during calculation

**kwargsdict

additional keyword arguments passed to each index (e.g. for setting a random seed in indices like ModifiedGini or ModifiedDissm)

Returns:

pandas.DataFrame

dataframe with statistic name as dataframe index and statistic value as dataframe values