get_contact_matrices#

get_contact_matrices(datadir=None, sheet_name=None, file_path_dic=None, delimiter=' ', header=None, use_default=False)[source]#

Create a dict of setting specific age contact matrices. 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.sheet_name. 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

• setting_code (string) – name of the physial contact setting: H for households, S for schools, W for workplaces, C for community or other

• sheet_name (string) – name of the sheet in the excel file with contact patterns

• file_path_dic (string) – dictionary to file paths of user specified age contact matrix, where keys are “H”, “S”, “W”, and “C”.

• delimiter (string) – delimter for the contact matrix file

• header (int) – row number for the header of the file

Returns:

A dictionary of the different contact matrices for each population, given by the sheet name. Keys map to the different possible physical contact settings for which data are available.

Return type:

dict