Closed njtierney closed 2 years ago
Some thoughts on sections / topics to address
Topics to address in a vignette called, "implementation details", which goes into greater depth of explaining various parts of the data analysis
get_polymod_setting_data()
and get_polymod_population()
dofit_setting_contacts()
function do? How does it do it? What does it use? Why do we use a GAM? Why are we predicting the number of contacts?predict_setting_contacts()
do? More clearly walking through that process of model fitting based on other models.plot_setting_matrices()
do? What do we learn from these matrices? What is the interpretation of these figures?generate_ngm()
do? Why would we want to use it?get_age_population_function()
get_household_size_distribution()
get_per_capita_household_size()
apply_vaccination()
do?done in #78
Write up a vignette that walks through the entire process and motivation for how conmat creates the contact matrices.
This should be written up in a way that is aimed at people who might not be as familiar with epidemiology. So, it will go into detail on what each of the steps in the model fitting does, what the polymod data is, and answer questions like:
This will involve fixing and simplifying the README, which is #35.