Module functions.metatables.standard_mapping
Functions
def create_age_break(metatable: MetaTable2, original_variable: str = 'S12_1', new_break_name: str = 'age_break', dont_know_code: bool = False) ‑> None
-
Creates a standard age break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_apartment_search_break(metatable: MetaTable2, original_variable: str = 'WOHNUNGSSUCHE', new_break_name: str = 'apartment_search_break', dont_know_code: bool = False) ‑> None
-
Creates a standard apartment_search break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_apartment_search_simple_break(metatable: MetaTable2, original_variable: str = 'WOHNUNGSSUCHE', new_break_name: str = 'apartment_search_break', dont_know_code: bool = False) ‑> None
-
Creates a standard apartment_search break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_canton_break(metatable: MetaTable2, original_variable: str, original_variable_type: str, new_break_name: str, dont_know_code: bool = False) ‑> None
-
Creates a canton break based on a JSON mapping file.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
original_variable_type
:str
- Type of the original variable. "gdenr" if it represents the Gemeindenummer.
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_cantonal_banc_break(metatable: MetaTable2, original_variable: str = 'KANTONALBANK', new_break_name: str = 'kantonalbank_break', dont_know_code: bool = False) ‑> None
-
Creates a standard kantonalbank break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_count_employee_break(metatable: MetaTable2, original_variable: str, new_break_name: str = 'count_employee_break', dont_know_code: bool = False) ‑> None
-
Creates a standard count employee break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
def create_custom_break(metatable: MetaTable2, original_variable: str, new_break_name: str, recode_values: tuple[dict[int, range], bool], value_labels: dict[int, str], single_label: str, measure: str = 'nominal') ‑> None
-
Creates a custom break in the specified Metatable.
Args
metatable
:MetaTable2
- The Metatable that needs editing.
original_variable
:str
- Name of the original variable.
new_break_name
:str
- Name of the newly created break.
recode_values
:Tuple[Dict[int, range], bool]
- Tuple with recode values and whether to keep untouched codes, e.g., ({1: range(1, 6), 2: range(6, 11)}, True).
value_labels
:Dict[int, str]
- Value labels dictionary, e.g., {1: '1-5', 2: '6-10'}.
single_label
:str
- Single label of the break.
measure
:str
- Break measure, nominal, scale, etc. Default is 'nominal'.
def create_education_break(metatable: MetaTable2, original_variable: str = 'S15', new_break_name: str = 'education_break', dont_know_code: bool = False) ‑> None
-
Creates a standard education break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_employment_break(metatable: MetaTable2, original_variable: str = 'S13', new_break_name: str = 'employment_break', dont_know_code: bool = False) ‑> None
-
Creates a standard employment break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_founding_year_break(metatable: MetaTable2, original_variable: str, new_break_name: str = 'founding_year_break', dont_know_code: bool = False) ‑> None
-
Creates a standard founding year break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_gdenr_from_plz(metatable: MetaTable2, original_variable: str, new_variable: str, dont_know_code: bool = False) ‑> None
-
Creates Gemeindenummer from PLZ based on a JSON mapping file.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_variable
:str
- Name of the newly created variable
dont_know_code
:bool
- should the dont know code be recoded
def create_gemeindegrösse_break(metatable: MetaTable2, original_variable: str, original_variable_type: str, new_break_name: str, dont_know_code: bool = False) ‑> None
-
Creates a gemeindegrösse break based on a JSON mapping file.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
original_variable_type
:str
- Type of the original variable. "gdenr" if it represents the Gemeindenummer.
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_gender_break(metatable: MetaTable2, original_variable: str = 'S11', new_break_name: str = 'gender_break', use_non_binary: bool = True, dont_know_code: bool = False) ‑> None
-
Creates a standard gender break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
use_non_binary
:bool
- Include "divers" gender if True, only use binary gender otherwise
dont_know_code
:bool
- should the dont know code be recoded
def create_grossregion_break(metatable: MetaTable2, original_variable: str, original_variable_type: str, new_break_name: str, dont_know_code: bool = False) ‑> None
-
Creates a grossregion break based on a JSON mapping file.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
original_variable_type
:str
- Type of the original variable. "gdenr" if it represents the Gemeindenummer.
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_income_break(metatable: MetaTable2, original_variable: str = 'S14', new_break_name: str = 'income_break', dont_know_code: bool = False) ‑> None
-
Creates a standard income break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_industry_sector_break(metatable: MetaTable2, original_variable: str, new_break_name: str = 'industry_sector_break', dont_know_code: bool = False, values: dict = {}, value_labels: dict = {}) ‑> None
-
Creates a standard industry sector (Branche, NOGA Code) break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
values
:dict
- dictionary with industry sector values (NOGA)
value_labels
:dict
- dictionary with industry sector value labels (NOGA)
def create_lead_time_break(metatable: MetaTable2, original_variable: str, new_break_name: str = 'lead_time_break', year: int = 2025, dont_know_code: bool = False) ‑> None
-
Creates a standard lead time break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_market_change_break(metatable: MetaTable2, original_variable: str, new_break_name: str = 'market_change_break', dont_know_code: bool = False) ‑> None
-
Creates a standard market change break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_method_break(metatable: MetaTable2, original_variable: str = 'method_break', new_break_name: str = 'method_break', other_category_break: str = 'Andere', dont_know_code: bool = False) ‑> None
-
Creates a standard method break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
other_category_break
:str
- Name of the "Others" category
dont_know_code
:bool
- should the dont know code be recoded
def create_ownership_break(metatable: MetaTable2, original_variable: str = 'EIGENTUEMERMIETER', new_break_name: str = 'ownership_break', dont_know_code: bool = False) ‑> None
-
Creates a standard ownership break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_role_break(metatable: MetaTable2, original_variables: str, new_break_name: str = 'role_break', dont_know_code: bool = False) ‑> None
-
Creates a standard role break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_role_year_break(metatable: MetaTable2, original_variable: str, new_break_name: str = 'create_role_year_break', dont_know_code: bool = False) ‑> None
-
Creates a standard role year break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_sex_break(metatable: MetaTable2, original_variable: str = 'S11', new_break_name: str = 'sex_break', use_non_binary: bool = True, dont_know_code: bool = False) ‑> None
-
Creates a standard sex break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
use_non_binary
:bool
- Include "diverse" sex if True, only use binary sex otherwise
dont_know_code
:bool
- should the dont know code be recoded
def create_siedlungsart_break(metatable: MetaTable2, original_variable: str, original_variable_type: str, new_break_name: str, dont_know_code: bool = False) ‑> None
-
Creates a siedlungsart break based on a JSON mapping file.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
original_variable_type
:str
- Type of the original variable. "gdenr" if it represents the Gemeindenummer.
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_sprachregion_break(metatable: MetaTable2, original_variable: str, original_variable_type: str, new_break_name: str, dont_know_code: bool = False) ‑> None
-
Creates a sprachregion break based on a JSON mapping file.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
original_variable_type
:str
- Type of the original variable. "gdenr" if it represents the Gemeindenummer.
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def create_total_column(metatable: MetaTable2, name: str = 'tz') ‑> None
-
Creates the total column used in many standard tasks.
Args
metatable
:MetaTable2
- The Metatable that needs editing
name
:str
- name to overwrite the column name, Defaults to tz.
def create_winner_loser_break(metatable: MetaTable2, original_variable: str, new_break_name: str = 'winner_loser_break', dont_know_code: bool = False) ‑> None
-
Creates a standard winner/loser break.
Args
metatable
:MetaTable2
- The Metatable that needs editing
original_variable
:str
- Name of the original variable
new_break_name
:str
- Name of the newly created break
dont_know_code
:bool
- should the dont know code be recoded
def get_mapping_json(original_variable_type: str, new_variable: str) ‑> dict
-
Reads the mapping json file to a dictionary
Args
original_variable_type
:str
- type of original variable. Either plz or gdenr
new_variable
:str
- name of new variable in mapping