get_head_age_brackets#

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

Get a dictionary of head age brackets either from the file_path directly, or using the other parameters to figure out what the file_path should be. 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 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 head age brackets 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 the settings.location, settings.state_location, settings.country_location.

Returns:

A dictionary of the age brackets for head of household distribution data. Keys map to the age bracket as an integer, values are the percent of households which head of household in that age bracket.

Return type:

dict