get_school_enrollment_rates#

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

Get dictionary of enrollment rates by age. 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 the location is in

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

• file_path (string) – file path to user specified school enrollment by age 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:

A dictionary of school enrollment rates by age.

Return type:

dict