get_head_age_by_size_distr#

get_head_age_by_size_distr(datadir=None, location=None, state_location=None, country_location=None, file_path=None, use_default=False)[source]#

Create an array of head of household age bracket counts (column) given by size (row). If use_default, then we’ll first try to look for location specific data and if that’s not available we’ll use default data from the settings.location, settings.state_location, settings.country_location. This may not be appropriate for the population under study so it’s best to provide as much data as you can for the specific population.

Parameters:

  • datadir (string) – file path to the data directory

  • location (string) – name of the location

  • state_location (string) – name of the state

  • country_location (string) – name of the country the state_location is in

  • file_path (string) – file path to user specified age of the head of the household by household size distribution data

  • use_default (bool) – if True, try to first use the other parameters to find data specific to the location under study, otherwise returns default data drawing from settings.location, settings.state_location, settings.country_location.

Returns:

An array where each row s represents the age distribution of the head of households for households of size s-1.

Return type:

ndarray