get_contact_matrix: Get contact matrix main function

In SC-COSMO/sccosmomcma: Stanford-CIDE COronavirus Simulation MOdel (SC-COSMO) for Mexico City Metropolitan Area Analysis

Description

get_contact_matrix wrapper function that allows user to subset data from various sources. If only county is specified (other parameters = ""), it provides national level data. If county is also specified (and the dataset contains counties), then only those counties within the state(s) are returned.

Usage

get_contact_matrix(
  v_init_age_grps = c(0, 5, 15, 25, 45, 55, 65, 70),
  country = "",
  state = "",
  county = "",
  src_country = "",
  density = "",
  v_custom_prop_pop = "",
  recache = FALSE
)

Arguments

v_init_age_grps	Vector that specifies the age bins to aggregate and return.
country	Country of desired data.
state	State of desired data.
county	County of desired data.
src_country	Country to use for contact matrix structure if country is not in data.frame.
density	Population density of country/state/county.
v_custom_prop_pop	Vector that specifies the proportion of total population for each age group.
recache	Flag (default is FALSE) of whether to run function and replace existing cache. If FALSE, will check for cache and use if cached matrix exists.

Value

A list with overall and setting specific contact matrices.

SC-COSMO/sccosmomcma documentation built on Dec. 18, 2021, 11:56 a.m.