finalsize is an R package to calculate the final size of a SIR epidemic in populations with heterogeneity in social contacts and infection susceptibility.
finalsize provides estimates for the total proportion of a population infected over the course of an epidemic, and can account for a demographic distribution (such as age groups) and demography-specific contact patterns, as well as for heterogeneous susceptibility to infection between groups (such as due to age-group specific immune responses) and within groups (such as due to immunisation programs). An advantage of this approach is that it requires fewer parameters to be defined compared to a model that simulates the full transmission dynamics over time, such as models in the epidemics package.
finalsize implements methods outlined in Andreasen (2011), Miller (2012), Kucharski et al. (2014), and Bidari et al. (2016).
finalsize can help provide rough estimates of the effectiveness of pharmaceutical interventions in the form of immunisation programmes, or the effect of naturally acquired immunity through previous infection (see the vignette).
finalsize relies on Eigen via RcppEigen for fast matrix algebra, and is developed at the Centre for the Mathematical Modelling of Infectious Diseases at the London School of Hygiene and Tropical Medicine as part of the Epiverse-TRACE.
Quick start
The main function in finalsize is final_size(), which calculates the final size of an epidemic given the R0.
# load finalsize
library(finalsize)
final_size(1.5)
#> demo_grp susc_grp susceptibility p_infected
#> 1 demo_grp_1 susc_grp_1 1 0.5828132Optionally, final_size() can estimate the epidemic size for populations with differences among demographic groups in their social contact patterns, in their susceptibility to infection.
We can use social contact data (here, from the socialmixr package) to estimate the final size of an epidemic when the disease has an R0 of 1.5, and given three age groups of interest — 0-19, 20-39 and 40+. The under-20 age group is assumed to be fully susceptible to the disease, whereas individuals aged over 20 are only half as susceptible as those under 20.
# Load example POLYMOD social contacts data included with the package
data(polymod_uk)
# Define contact matrix (entry {ij} is contacts in group i reported by group j)
contact_matrix <- polymod_uk$contact_matrix
# Define population in each age group
demography_vector <- polymod_uk$demography_vector
# Define susceptibility of each group
susceptibility <- matrix(
data = c(1.0, 0.5, 0.5),
nrow = length(demography_vector),
ncol = 1
)
# Assume uniform susceptibility within age groups
p_susceptibility <- matrix(
data = 1.0,
nrow = length(demography_vector),
ncol = 1
)
# R0 of the disease
r0 <- 1.5 # assumed for pandemic influenza
# Calculate the proportion of individuals infected in each age group
final_size(
r0 = r0,
contact_matrix = contact_matrix,
demography_vector = demography_vector,
susceptibility = susceptibility,
p_susceptibility = p_susceptibility
)
#> demo_grp susc_grp susceptibility p_infected
#> 1 [0,20) susc_grp_1 1.0 0.32849966
#> 2 [20,40) susc_grp_1 0.5 0.10532481
#> 3 40+ susc_grp_1 0.5 0.06995193Helper functions included in finalsize are provided to calculate the effective R0, called Reff, from demographic and susceptibility distribution data, while other helpers can convert between R0 and the transmission rate λ.
# calculate the effective R0 using `r_eff()`
r_eff(
r0 = r0,
contact_matrix = contact_matrix,
demography_vector = demography_vector,
susceptibility = susceptibility,
p_susceptibility = p_susceptibility
)
#> [1] 1.171758Package vignettes
More details on how to use finalsize can be found in the online documentation as package vignettes, under “Articles”.
Help
To report a bug please open an issue.
Contribute
Contributions to finalsize are welcomed. Please follow the package contributing guide.
Code of conduct
Please note that the finalsize project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Citing this package
citation("finalsize")
#> To cite package 'finalsize' in publications use:
#>
#> Gupte P, Van Leeuwen E, Kucharski A (2024). _finalsize: Calculate the
#> Final Size of an Epidemic_. R package version 0.2.1,
#> https://epiverse-trace.github.io/finalsize/,
#> <https://github.com/epiverse-trace/finalsize>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {finalsize: Calculate the Final Size of an Epidemic},
#> author = {Pratik Gupte and Edwin {Van Leeuwen} and Adam Kucharski},
#> year = {2024},
#> note = {R package version 0.2.1,
#> https://epiverse-trace.github.io/finalsize/},
#> url = {https://github.com/epiverse-trace/finalsize},
#> }