R/data_polymod_model.R

In njtierney/conmat: Builds Contact Matrices using GAMs and Population Data

#' @title Polymod Settings models
#'
#' @description A data object containing a list of fitted gam models
#'   predicting the number of contacts in each of the four settings which are
#'   "home","work","school" and "other". For more details on model fitting,
#'   see [fit_setting_contacts()]. This object has been provided as data to
#'   avoid recomputing a relatively common type of model for use with `conmat`.
#'
#' @seealso [fit_setting_contacts()]
#' @examples
#' \dontrun{
#' # code used to produce this data
#' library(conmat)
#' set.seed(2022 - 08 - 26)
#' polymod_contact_data <- get_polymod_setting_data()
#' polymod_survey_data <- get_polymod_population()
#' polymod_setting_models <- fit_setting_contacts(
#'   contact_data_list = polymod_contact_data,
#'   # population = polymod_survey_data
#' )
#' }
#'
"polymod_setting_models"