Man pages for njtierney/conmat
Builds Contact Matrices using GAMs and Population Data

abs_abbreviate_statesAbbreviate Australian State Names
abs_age_dataReturn Australian Bureau of Statistics (ABS) age population...
abs-age-educationReturn data on educated population for a given age and state...
abs-age-workReturn data on employed population for a given age and state...
abs_avg_schoolABS education data for 2016
abs_avg_workABS work data for 2016
abs_education_stateABS education by state for 2006-2020
abs_education_state_20202020 ABS education population data, interpolated into 1 year...
abs_employ_age_lgaABS employment by age and LGA for 2016
abs_household_lgaABS household data for 2016
abs_lga_lookupABS lookup table of states, lga code and lga name
abs_pop_age_lga_2016ABS population by age for 2016 for LGAs
abs_pop_age_lga_2020ABS population by age for 2020 for LGAs
abs_state_ageABS state population data for 2020
abs_unabbreviate_statesUn-abbreviate Australian state names
accessorsAccessing conmat attributes
add_intergenerationalAdd column, "intergenerational"
add_modelling_featuresAdd features required for modelling to the dataset
add_offsetAdds offset variables
add_population_age_toAdd the population distribution for contact ages.
add_school_work_participationAdd columns describing the fractions of the population in...
add_symmetrical_featuresAdd symmetrical, age based features
age_breaksExtract age break attribute information
age_group_lookupLookup table of age groups in 5 year bins
age_populationGet cleaned population data with lower and upper limits of...
aggregate_predicted_contactsAggregate predicted contacts to specified age breaks
apply_vaccinationApply vaccination effects to next generation contact matrices
as_conmat_populationConvert to conmat population
as_setting_prediction_matrixCoerce object to a setting prediction matrix
autoplot-conmatPlot setting matrices using ggplot2
autoplot-conmat-partialPlot partial predictive plots using ggplot2
check_dimensionsCheck dimensions
check_if_listCheck if data is a list
check_school_demographicsCheck School Demographics
check_work_demographicsCheck Work Demographics
clean_age_population_yearPrepare age population data
conmat_original_school_demographicsOriginal school demographics for conmat
conmat_original_work_demographicsOriginal work demographics for conmat
conmat-packageconmat: Builds Contact Matrices using GAMs and Population...
conmat_populationDefine a conmat population
data_abs_lga_educationLGA wise ABS education population data on different ages for...
data_abs_lga_workLGA wise ABS work population data on different ages for year...
data_abs_state_educationState wise ABS education population data on different ages...
data_abs_state_workState wise ABS work population data on different ages for...
davies_age_extendedSusceptibility and clinical fraction parameters from Davies...
estimate_setting_contactsGet predicted setting specific as well as combined contact...
extrapolate_polymodFit all-of-polymod model and extrapolate to a given...
eyre_transmission_probabilitiesTransmission probabilities of COVID19 from Eyre et al.
fit_setting_contactsFit a contact model to a survey population
fit_single_contact_modelFit a single GAM contact model to a dataset
formula-termsExtract out formula terms
generate_ngmCalculate next generation contact matrices
generate_ngm_ozCalculate next generation contact matrices from ABS data
get_abs_household_size_distributionGet household size distribution based on state or LGA name
get_abs_household_size_populationGet population associated with each household size in an LGA...
get_abs_per_capita_household_sizeGet per capita household size based on state or LGA name
get_abs_per_capita_household_size_lgaGet household size distribution based on LGA name
get_abs_per_capita_household_size_stateGet household size distribution based on state name
get_age_population_functionReturn an interpolating function for populations in 1y age...
get_polymod_contact_dataFormat POLYMOD data and filter contacts to certain settings
get_polymod_per_capita_household_sizeGet polymod per capita household size.
get_polymod_populationReturn the polymod-average population age distribution in 5y
get_polymod_setting_dataGet polymod setting data
get_setting_transmission_matricesGet Setting Transmission Matrices
matrix_to_predictionsConvert a contact matrix as output into a long-form tibble
new_age_matrixBuild new age matrix
new_conmat_populationCreate a new 'conmat_population' class object
new_ngm_setting_matrixEstablish new BGM setting data
new_setting_dataEstablish new setting data
partial-predictionCreate partial predictions and partial prediction plots.
partial-prediction-sumCreate partial predictive plots for a set of fitted models.
per_capita_household_sizeGet per capita household size with household size...
pipePipe operator
polymodSocial contact data from 8 European countries (imported from...
polymod_setting_modelsPolymod Settings models
predict_contactsPredict contact rate between two age populations, given some...
predict_contacts_1yPredict contact rate to a given population at full 1y...
predictions_to_matrixConvert dataframe of predicted contacts into matrix
predict_setting_contactsPredict setting contacts
prem_germany_contact_matricesContact matrices as calculated by Prem. et al.
prepare_population_for_modellingPrepare population data for generating an age population...
raw_eigenvalueGet raw eigvenvalue from NGM matrix
reexportsObjects exported from other packages
scalingGet the scaling from NGM matrix
separate_age_groupSeparate age groups
setting_prediction_matrixCreate a setting prediction matrix
setting_weightsSetting weights computed for transmission probabilities.
transmission_probability_matrixCreate a setting transmission matrix
vaccination_effect_example_dataExample dataset with information on age based vaccination...
njtierney/conmat documentation built on April 17, 2025, 10:27 p.m.