leap.data_generation.utils module¶

leap.data_generation.utils.get_province_id(province: str) → str[source]¶

Convert full length province name to abbreviation.

Parameters:¶

province: str¶

The full length province name, e.g. British Columbia.

Returns:¶

The abbreviation for the province, e.g. BC.

leap.data_generation.utils.get_sex_id(sex: str) → str[source]¶

Convert full length sex to single character.

Parameters:¶

sex: str¶

The full length string, either Female or Male

Returns:¶

The single character string, either F or M.

leap.data_generation.utils.format_age_group(age_group: str, upper_age_group: str = '100 years and over') → int[source]¶

Convert age group to integer.

Parameters:¶

age_group: str¶

The age group string, e.g. 5 to 9 years.

upper_age_group: str = '100 years and over'¶

The upper age group string, e.g. 100 years and over.

Returns:¶

The integer age.

Examples:

>>> format_age_group("110 years and over", "110 years and over")
110
>>> format_age_group("Under 1 year", "100 years and over")
0
>>> format_age_group("9 years")
9