auxiliary/modelfiles/DSAIDE/simulators/simulate_SEIRSd_model_ode.R

In ahgroup/modelbuilder: Building Compartmental Simulation Models Without Coding

#' SEIRSd model
#' 
#' @description A SEIRS model with 4 compartments
#' 
#' @details The model includes susceptible, exposed/asymptomatic, infected/symptomatic, and recovered compartments. The processes that are modeled are infection, progression to infectiousness, recovery and waning immunity. Demographics through natural births and deaths are also included.
#' 
#' This code was generated by the modelbuilder R package.  
#' The model is implemented as a set of ordinary differential equations using the deSolve package. 
#' The following R packages need to be loaded for the function to work: deSolve. 
#' 
#' @param S : starting value for Susceptible : numeric
#' @param E : starting value for Exposed : numeric
#' @param I : starting value for Infected and Symptomatic : numeric
#' @param R : starting value for Recovered : numeric
#' @param bE : infection by exposed : numeric
#' @param bI : infection by symptomatic : numeric
#' @param gE : progression rate : numeric
#' @param gI : recovery rate : numeric
#' @param w : waning immunity : numeric
#' @param n : births : numeric
#' @param m : deaths : numeric
#' @param tstart : Start time of simulation : numeric
#' @param tfinal : Final time of simulation : numeric
#' @param dt : Time step : numeric
#' @return The function returns the output as a list. 
#' The time-series from the simulation is returned as a dataframe saved as list element \code{ts}. 
#' The \code{ts} dataframe has one column per compartment/variable. The first column is time.   
#' @examples  
#' # To run the simulation with default parameters:  
#' result <- simulate_SEIRSd_model_ode() 
#' # To choose values other than the standard one, specify them like this:  
#' result <- simulate_SEIRSd_model_ode(S = 2000,E = 2,I = 2,R = 0) 
#' # You can display or further process the result, like this:  
#' plot(result$ts[,'time'],result$ts[,'S'],xlab='Time',ylab='Numbers',type='l') 
#' print(paste('Max number of S: ',max(result$ts[,'S']))) 
#' @section Warning: This function does not perform any error checking. So if you try to do something nonsensical (e.g. have negative values for parameters), the code will likely abort with an error message.
#' @section Model Author: Andreas Handel
#' @section Model creation date: 2020-09-28
#' @section Code Author: generated by the \code{modelbuilder} R package 
#' @section Code creation date: 2021-07-19
#' @export 
 
simulate_SEIRSd_model_ode <- function(S = 1000, E = 1, I = 1, R = 0, bE = 0, bI = 0.001, gE = 1, gI = 1, w = 1, n = 0, m = 0, tstart = 0, tfinal = 100, dt = 0.1) 
{ 
  ############################## 
  #Block of ODE equations for deSolve 
  ############################## 
  SEIRSd_model_ode_fct <- function(t, y, parms) 
  {
    with( as.list(c(y,parms)), { #lets us access variables and parameters stored in y and parms by name 
    #StartODES
    #Susceptible : infection by exposed : infection by symptomatic : waning immunity : births : natural deaths :
    dS_mb = -bE*S*E -bI*S*I +w*R +n -m*S
    #Exposed : infection by exposed : infection by symptomatic : progression to symptoms : natural deaths :
    dE_mb = +bE*S*E +bI*S*I -gE*E -m*E
    #Infected and Symptomatic : progression to symptoms : recovery : natural deaths :
    dI_mb = +gE*E -gI*I -m*I
    #Recovered : recovery : waning immunity : natural death :
    dR_mb = +gI*I -w*R -m*R
    #EndODES
    list(c(dS_mb,dE_mb,dI_mb,dR_mb)) 
  } ) } #close with statement, end ODE code block 
 
  ############################## 
  #Main function code block 
  ############################## 
  #Creating named vectors 
  varvec_mb = c(S = S, E = E, I = I, R = R) 
  parvec_mb = c(bE = bE, bI = bI, gE = gE, gI = gI, w = w, n = n, m = m) 
  timevec_mb = seq(tstart, tfinal,by = dt) 
  #Running the model 
  simout = deSolve::ode(y = varvec_mb, parms = parvec_mb, times = timevec_mb,  func = SEIRSd_model_ode_fct, rtol = 1e-12, atol = 1e-12) 
  #Setting up empty list and returning result as data frame called ts 
  result <- list() 
  result$ts <- as.data.frame(simout) 
  return(result) 
}