SEIRD_BD-class: An S4 object representing the SEIRD_BD model.

In Como-DTC-Collaboration/como-models: A Suite of CoMo Models

An S4 object representing the SEIRD_BD model.

Description

This class represents the SEIRD_BD model, showing how populations of susceptible, exposed, infectious and recovered individuals evolve over time.

Usage

## S4 method for signature 'SEIRD_BD'
initial_conditions(object)

## S4 method for signature 'SEIRD_BD'
transmission_parameters(object)

## S4 replacement method for signature 'SEIRD_BD'
initial_conditions(object) <- value

## S4 replacement method for signature 'SEIRD_BD'
transmission_parameters(object) <- value

## S4 method for signature 'SEIRD_BD'
run(object, times, solve_method = "lsoda")

## S4 method for signature 'SEIRD_BD'
R0(model)

## S4 method for signature 'SEIRD_BD'
ode_structure_diagram(model)

Arguments

object	an object of the class SEIRD_BD
value	(list) list of values for beta, kappa, gamma, mu, lambda, nu
times	(double) a sequence of time points at which the solution to the system of ODEs should be returned. Must be of the form seq(t_start, t_end, by=t_step). Default time series is seq(0, 100, by = 1).
solve_method	(string) a string of chosen numerical integration method for solving the ode system. Default is lsoda which is also the default for the ode function in the deSolve package used in this function.
model	an SEIRD_BD model

Value

object of class SEIRD_BD with initial conditions assigned.

object of class SEIRD_BD with transmission parameter values assigned.

two dataframes: one with the time steps, age range, time series of S, E, I, R and D population fractions, and one with the time steps, age range, time series of incidences and deaths population fraction.

an R0 value

An ODE-compartmental structure diagram object of class html

Methods (by generic)

• initial_conditions: Retrieves initial conditions of SEIRD_BD model.

• transmission_parameters: Retrieves transmission parameters of SEIRD_BD model.

• initial_conditions<-: Setter method for initial conditions (S0, E0, I0 and R0) of the SEIRD_BD model.

  All initial conditions must sum up to 1. If the initial conditions provided to do not sum to 1, an error is thrown.

• transmission_parameters<-: Set transmission parameters (beta, kappa, gamma, mu, lambda, nu) of the SEIRD_BD model.

  If the transmission parameters provided to are not 1-dimensional an error is thrown.

• run: Solves ODEs of the SEIRD_BD specified in object for the time points specified in times and integration method specified in solve_method.

  \frac{dS(t)}{dt} = lambda + delta R(t) - beta S(t) I(t) - nu S(t)

  \frac{dE(t)}{dt} = beta S(t) I(t) - kappa E(t) - nu E(t)

  \frac{dI(t)}{dt} = kappa E(t) - (gamma + mu) I(t) - nu I(t)

  \frac{dR(t)}{dt} = gamma I(t) - (nu + delta) R(t)

  \frac{dD(t)}{dt} = mu I(t) + nu (S(t) + E(t) + I(t) + R(t))

  \frac{dC(t)}{dt} = beta S(t) I(t)

  This function relies on the package deSolve.

• R0: Calculates basic reproduction number for SEIRD_BD model

  The R0 parameter is given by:

  R_0 = β κ / (κ + ν) * 1/(γ + μ + ν)

• ode_structure_diagram: Prints a compartmental diagram for the SEIRD_BD model

Slots

output_names

list of compartments name which are used by the model and incidence.

initial_condition_names

list of names of initial conditions (characters). Default is list("S0", "E0", "I0", R0").

transmission_parameter_names

list of names of transmission parameters (characters). Default is list("beta", "kappa", "gamma", "mu", "lambda", "nu", "delta").

initial_conditions

list of values for initial conditions (double).

transmission_parameters

list of values for transmission parameters (double).

Como-DTC-Collaboration/como-models documentation built on May 22, 2022, 9:33 a.m.