Package 'SEIRfansy' reference manual

Title:	Extended Susceptible-Exposed-Infected-Recovery Model
Description:	Extended Susceptible-Exposed-Infected-Recovery Model for handling high false negative rate and symptom based administration of diagnostic tests. <doi:10.1101/2020.09.24.20200238>.
Authors:	Ritwik Bhaduri [aut], Ritoban Kundu [aut], Soumik Purkayastha [aut], Lauren Beesley [aut], Bhramar Mukherjee [aut], Michael Kleinsasser [cre]
Maintainer:	Michael Kleinsasser <[email protected]>
License:	GPL-2
Version:	1.1.1
Built:	2024-10-12 04:56:01 UTC
Source:	https://github.com/umich-biostatistics/seirfansy

COVID-19 Cases Time Series in India

Description

Contains dailies and totals of cases, recoveries, and deaths from the COVID-19 outbreak in India from January 30 to September 21 of 2020.

Usage

covid19
covid19

Format

An object of class data.frame with 236 rows and 7 columns.

Date: Date as a character string
Daily.Confirmed: Daily confirmed cases as an integer vector
Total.Confirmed: Total confirmed cases upto current date as an integer vector
Daily.Recovered: Daily recovered cases an an integer vector
Total.Recovered: Total confirmed cases upto current date as an integer vector
Daily.Deceased: Daily deceased cases as an integer vector
Total.Deceased: Total deceased cases upto current date as an integer vector

Examples

covid19
head(covid19)
tail(covid19)
covid19
head(covid19)
tail(covid19)

Plot an SEIRfansy Fit Object

Description

This is a convenient wrapper for output that is already included in the SEIRfansy output in the plots element. Options are trace or boxplot.

Usage

## S3 method for class 'SEIRfansy'
plot(x, type, ...)
## S3 method for class 'SEIRfansy'
plot(x, type, ...)

Arguments

`x`	SEIRfansy object to plot
`type`	type of plot to render. Options are "trace" or "boxplot".
`...`	not currently used

Plot an SEIRfansyPredict Fit Object

Description

This is a convenient wrapper for output that is already included in the predict output in the plots element. Options are panel and cases.

Usage

## S3 method for class 'SEIRfansyPredict'
plot(x, type, ...)
## S3 method for class 'SEIRfansyPredict'
plot(x, type, ...)

Arguments

`x`	SEIRfansyPredict object to plot
`type`	type of plot to render. Options are "trace", "boxplot", "panel", or "cases".
`...`	not currently used

Estimate SEIRfansy Model Parameters

Description

This function is used to estimate the different parameters of interest like the time varying transmission rates, proportion of reported cases, and the basic reproduction rates.

Usage

SEIRfansy(
  data,
  data_init,
  N,
  init_pars = NULL,
  niter = 1e+05,
  BurnIn = 1e+05,
  model = "Multinomial",
  plot = TRUE,
  period_start,
  auto.initialize = TRUE,
  ...
)
SEIRfansy(
  data,
  data_init,
  N,
  init_pars = NULL,
  niter = 1e+05,
  BurnIn = 1e+05,
  model = "Multinomial",
  plot = TRUE,
  period_start,
  auto.initialize = TRUE,
  ...
)

Arguments

`data`	(mandatory): If the model is Multinomial, then the data matrix should contain the 3 columns Confirmed, Recovered, and Death. If the model is Poisson or Binomial, then the data should contain only the column Confirmed. Please ensure that the names of the columns are exactly as stated above.
`data_init`	(mandatory): These are the initial data values provided by the user as a numeric vector of length six. The entries should be the Total Confirmed, Total Recovered, Total Death, Daily Confirmed, Daily Recovered, and Daily Death for the Starting Date. Note: If the starting total confirmed is 0, please replace it by 1.
`N`	(mandatory): The population size.
`init_pars`	NULL(default): If not equal to NULL, then the user can give a user input initial parameters which should consist of the initial values of the time varying beta, proportion of testing for the different periods.
`niter`	1e5 (default): Number of iterations for the MCMC Metropolis Hastings algorithm.
`BurnIn`	5e4 (default): This is the number of burn-in iterations for the MCMC algorithm
`model`	"Multinomial" (default): This is the likelihood function that will be used. There are three options available: "Multinomial", "Poisson", or "Binomial".
`plot`	TRUE (default): This will give the box plot for the basic reproduction number for the different periods.
`period_start`	The total time period is divided into small periods depending on the lock down measures imposed by the government. So this is a numeric vector consisting of the start dates for the different time periods.
`auto.initialize`	TRUE (default): This is the option for using a mle based initial parameter.
`...`	arguments passed to the function model_initializeR and model_plotR which is used for initializing the parameters. The parameters are described below: step_pars: init_pars/500 (default): It is the variance of the proposal distribution for the Metropolis Hastings Algorithm which is assumed to be a Random Walk. alpha_p: 0.5 (default): It is defined as the ratio of rate of spread of infection by tested positive patients to that by false negatives. We have taken $alpha_p < 1$ as patients who are tested positive are subjected to quarantine where the chance of spreading the disease is less than that of false negative patients who are mostly unaware of their infectious nature. So, false negative individuals continue to spread the disease freely at a higher rate than tested positive individuals. alpha_u: 0.7 (default): It is defined as the scaling factor for the rate of spread of infection by untested individuals. $alpha_u$ is assumed to be < 1 as U mostly consists of asymptomatic or mildly symptomatic cases who are known to spread the disease at a much lower rate than those with higher levels of symptoms. beta_1: 0.6 (default): It is the scaling factor for rate of recovery for untested individuals. $beta_1$ is assumed to be less than 1. The condition of Untested individuals is not as severe as they consist of mostly asymptomatic people. So, they are assumed to recover faster than the Current Positive ones. beta_2: 0.7 (default): It is the inverse of the scaling factor for rate of recovery for false negative individuals. $beta_2$ is assumed to be less than 1. It is assumed that the recovery rate is slower than the detected ones for the False Negative ones because they are not getting any hospital treatments. delta_1: 0.3 (default): It is the scaling factor for death rate for undetected individuals. $delta_1$ is assumed to be less than 1. Similarly for the Untested ones, the death rate is taken to be lesser because they are mostly asymptomatic. So, their probability of dying is much lower. delta_2: 0.7 (default): It is the inverse of the scaling factor for death rate for false negative individuals. $delta_2$ is assumed to be less than 1. Same as before, the death rate for False Negative ones are assumed to be higher than the Current detected Positive as they are not receiving proper treatment. lambda: 1 / (66.26 * 365) (default): Natural birth rate. The value given here as the default value is the world's common birth rate. mu: 1 / (66.26 * 365) (default): Natural death rates. This is assumed to be equal with natural birth rate for the sake of simplicity. D_d: 17.8 (default): Mean days until death for positive individuals. D_e: 5.2 (default): Incubation period. Dr: 17.8 (default): Mean days until recovery for positive individuals. f: 0.15 (default): False negative probability of RT-PCR test. mCFR: NULL (It is calculated from the data by default) It is defined as the ratio of the total reported deceased cases and the total removed cases until that day. init.exposed.ratio: 3 (default): This is the scaling factor for the calculation of the initial number of exposed people from the sum of the initial number of unreported, reported people. init.confirmed.ratio: 0.15 (default): This is the initial value of the probability of being tested. opt_num: 100 (default): The number of times an user wants to run the mle optimization before deciding on the best initial parameter. trace_plot.common_axis: FALSE (default): This will give the trace plot for the convergence of the MCMC estimated time varying parameters. save plot: TRUE (default): It is the option for saving the plots in the directory folder.

Value

A list with class "SEIRfansy", which contains the items described below:

mcmc_pars: a matrix of the mcmc draws for the parameters
plots: a list of ggplot objects

Examples

library(dplyr)
train = covid19[which(covid19$Date == "01 April "):which(covid19$Date == "30 June "),]
test = covid19[which(covid19$Date == "01 July "):which(covid19$Date == "31 July "),]

train_multinom = 
 train %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
 test_multinom = 
   test %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
N = 1341e6 # population size of India
data_initial = c(2059, 169, 58, 424, 9, 11)
pars_start = c(c(1,0.8,0.6,0.4,0.2), c(0.2,0.2,0.2,0.25,0.2))
phases = c(1,15,34,48,62)

cov19est = SEIRfansy(data = train_multinom, init_pars = pars_start, 
                     data_init = data_initial, niter = 1e3, BurnIn = 1e2, 
                     model = "Multinomial", N = N, lambda = 1/(69.416 * 365), 
                     mu = 1/(69.416 * 365), period_start = phases, opt_num = 1, 
                     auto.initialize = TRUE, f = 0.15)

names(cov19est)
class(cov19est$mcmc_pars)
names(cov19est$plots)

plot(cov19est, type = "trace")
plot(cov19est, type = "boxplot")









# quick test for package check
# not for use outside CRAN check()
cov19est = SEIRfansy(data = train_multinom, init_pars = pars_start, 
                     data_init = data_initial, niter = 33, BurnIn = 18, 
                     model = "Multinomial", N = N, lambda = 1/(69.416 * 365), 
                     mu = 1/(69.416 * 365), period_start = phases, opt_num = 1, 
                     auto.initialize = TRUE, f = 0.15, plot = FALSE, system_test = NULL)


library(dplyr)
train = covid19[which(covid19$Date == "01 April "):which(covid19$Date == "30 June "),]
test = covid19[which(covid19$Date == "01 July "):which(covid19$Date == "31 July "),]

train_multinom = 
 train %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
 test_multinom = 
   test %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
N = 1341e6 # population size of India
data_initial = c(2059, 169, 58, 424, 9, 11)
pars_start = c(c(1,0.8,0.6,0.4,0.2), c(0.2,0.2,0.2,0.25,0.2))
phases = c(1,15,34,48,62)

cov19est = SEIRfansy(data = train_multinom, init_pars = pars_start, 
                     data_init = data_initial, niter = 1e3, BurnIn = 1e2, 
                     model = "Multinomial", N = N, lambda = 1/(69.416 * 365), 
                     mu = 1/(69.416 * 365), period_start = phases, opt_num = 1, 
                     auto.initialize = TRUE, f = 0.15)

names(cov19est)
class(cov19est$mcmc_pars)
names(cov19est$plots)

plot(cov19est, type = "trace")
plot(cov19est, type = "boxplot")









# quick test for package check
# not for use outside CRAN check()
cov19est = SEIRfansy(data = train_multinom, init_pars = pars_start, 
                     data_init = data_initial, niter = 33, BurnIn = 18, 
                     model = "Multinomial", N = N, lambda = 1/(69.416 * 365), 
                     mu = 1/(69.416 * 365), period_start = phases, opt_num = 1, 
                     auto.initialize = TRUE, f = 0.15, plot = FALSE, system_test = NULL)

Prediction for SEIRfansy Model

Description

This function is used to predict the total reported as well as unreported case counts, total recovered, and total deaths.

Usage

SEIRfansy.predict(
  data = NULL,
  data_init,
  init_pars = NULL,
  N,
  plot = TRUE,
  T_predict,
  period_start,
  estimate = TRUE,
  pars = NULL,
  data_test = NULL,
  auto.initialize = TRUE,
  ...
)
SEIRfansy.predict(
  data = NULL,
  data_init,
  init_pars = NULL,
  N,
  plot = TRUE,
  T_predict,
  period_start,
  estimate = TRUE,
  pars = NULL,
  data_test = NULL,
  auto.initialize = TRUE,
  ...
)

Arguments

`data`	(mandatory): input the training data set. If the model is Multinomial then the data matrix should contain the 3 columns Confirmed, Recovered, and Death. If the model is Poisson or Binomial, then the data should contain only the column Confirmed. Note that the names of the columns must be the same as stated above.
`data_init`	(mandatory): These are the initial data values provided by the user as a numeric vector of length six. The entries should be the Total Confirmed, Total Recovered, Total Death, Daily Confirmed, Daily Recovered, and Daily Death for the Starting Date. Note: If the starting total confirmed is 0, please replace it by 1.
`init_pars`	NULL (default): If not equal to NULL, then the user can give a user input initial parameters which should consist of the initial values of the time varying beta, proportion of testing for the different periods.
`N`	(mandatory): The population size.
`plot`	TRUE (default): If estimate = FALSE, this will give two plots. One is the panel plot for total cases, total recovered, total death, and total confirmed if the model is Multinomial. Otherwise it will give only a plot for total confirmed when the model is binomial or Poisson, and the second plot is the plot of untested, false negative, and reported cases. And when estimate = TRUE, it will give two other plots along with the previous two plots. One is the box plot for basic reproduction number and the other one is the trace plot for the convergence of the MCMC parameters.
`T_predict`	It is the number of days that we want to predict after the train period. The value of T_predict should be greater than or equal to the number of rows of `data_test`.
`period_start`	The total time period is divided into small periods depending on the lock down measures imposed by the government. So this is a numeric vector consisting of the start dates for the different time periods.
`estimate`	TRUE (default): If it is TRUE then it will run the MCMC algorithm to estimate the parameters. If it is FALSE, then the user needs to give input the parameter values in the pars argument.
`pars`	= NULL (default): If estimate = FALSE, then the user needs to input the parameter estimates.
`data_test`	NULL (default): Otherwise need to give the test data for comparing with the model estimates.
`auto.initialize`	TRUE (default): This is the option for using a mle based initial parameter.
`...`	arguments passed to the function SEIRfansy, model_initializeR and model_plotR which are used for initializing the parameters. The parameters are described below: niter: 1e5 (default): Number of iteration for the MCMC metropolis hasting algorithm. BurnIn: 5e4 (default) This is the Burn-In Period for the MCMC algorithm. model: "Multinomial" (default): This is the likelihood function that will be used. There are three options available including "Multinomial", "Poisson", and "Binomial". alpha_p: 0.5 (default): It is defined as the ratio of rate of spread of infection by tested positive patients to that by false negatives. We have taken $alpha_p < 1$ as patients who are tested positive are subjected to quarantine where the chance of spreading the disease is less than that of false negative patients who are mostly unaware of their infectious nature. So, false negative individuals continue to spread the disease freely at a higher rate than tested positive individuals. alpha_u: 0.7 (default): It is defined as the scaling factor for the rate of spread of infection by untested individuals. $alpha_u$ is assumed to be < 1 as U mostly consists of asymptomatic or mildly symptomatic cases who are known to spread the disease at a much lower rate than those with higher levels of symptoms. beta_1: 0.6 (default): It is the scaling factor for rate of recovery for untested individuals. $beta_1$ is assumed to be less than 1. The condition of Untested individuals is not so severe as they consist of mostly asymptomatic people. So, they are assumed to recover faster than the Current Positive ones. beta_2: 0.7 (default): It is the inverse of the scaling factor for rate of recovery for false negative individuals. $beta_2$ is assumed to be less than 1. It is assumed that the recovery rate is slower than the detected ones for the False Negative ones because they are not getting any hospital treatment. delta_1: 0.3 (default): It is the scaling factor for death rate for undetected individuals. $delta_1$ is assumed to be less than 1. Similarly, for the Untested ones, the death rate is taken to be lesser because they are mostly asymptomatic. So, their probability of dying is much less. delta_2: 0.7 (default): It is the inverse of the scaling factor for death rate for false negative individuals. $delta_2$ is assumed to be less than 1. Same as before, the death rate for False Negative ones are assumed to be higher than the Current detected Positive as they are not receiving proper treatment. lambda: 1 / (66.26 * 365) (default): Natural birth rate. The value given here as the default value is the world's common birth rate. mu: 1 / (66.26 * 365) (default): Natural death rates. This is assumed to be equal with natural birth rate for the sake of simplicity. D_e: 5.2 (default): Incubation period. Dr: 17.8 (default): Mean days until recovery for positive individuals. f: 0.15 (default): False negative probability of RT-PCR test. mCFR: NULL (default): (It is calculated from the data by default) It is defined as the ratio of the total reported deceased cases and the total removed cases until that day. init.exposed.ratio: 3 (default): This is the scaling factor for the calculation of the initial number of exposed people from the sum of the initial number of unreported, reported people. init.confirmed.ratio: 0.15 (default): This is the initial value of the probability of being tested. opt_num: 100 (default): The number of times an user wants to run the mle optimization before deciding on the best initial parameter. trace_plot.common_axis: FALSE (default): This will give the trace plot for the convergence of the MCMC estimated time varying parameters. save plot: TRUE (default): It is the option for saving the plots in the directory folder.

Value

A list with class "SEIRfansyPredict", which contains the items described below:

mcmc_pars: a matrix of the mcmc draws for the parameters
plots: a list of ggplot objects

Examples

library(dplyr)
train = covid19[which(covid19$Date == "01 April "):which(covid19$Date == "30 June "),]
test = covid19[which(covid19$Date == "01 July "):which(covid19$Date == "31 July "),]

train_multinom = 
 train %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
 test_multinom = 
   test %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
N = 1341e6 # population size of India
data_initial = c(2059, 169, 58, 424, 9, 11)
pars_start = c(c(1,0.8,0.6,0.4,0.2), c(0.2,0.2,0.2,0.25,0.2))
phases = c(1,15,34,48,62)
 
 cov19pred = SEIRfansy.predict(data = train_multinom, init_pars = pars_start, 
                               data_init = data_initial, T_predict = 60, niter = 1e3, 
                               BurnIn = 1e2, data_test = test_multinom, model = "Multinomial", 
                               N = N, lambda = 1/(69.416 * 365), mu = 1/(69.416 * 365), 
                               period_start = phases, opt_num = 1, 
                               auto.initialize = TRUE, f = 0.15)

names(cov19pred)
class(cov19pred$prediction)
class(cov19pred$mcmc_pars)
names(cov19pred$plots)

plot(cov19pred, type = "trace")
plot(cov19pred, type = "boxplot")
plot(cov19pred, type = "panel")
plot(cov19pred, type = "cases")








# quick test for package check
# not for use outside CRAN check()
cov19est = SEIRfansy(data = train_multinom, init_pars = pars_start, 
                     data_init = data_initial, niter = 33, BurnIn = 18, 
                     model = "Multinomial", N = N, lambda = 1/(69.416 * 365), 
                     mu = 1/(69.416 * 365), period_start = phases, opt_num = 1, 
                     auto.initialize = TRUE, f = 0.15, plot = FALSE, system_test = NULL)


library(dplyr)
train = covid19[which(covid19$Date == "01 April "):which(covid19$Date == "30 June "),]
test = covid19[which(covid19$Date == "01 July "):which(covid19$Date == "31 July "),]

train_multinom = 
 train %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
 test_multinom = 
   test %>% 
   rename(Confirmed = Daily.Confirmed, 
          Recovered = Daily.Recovered,
          Deceased = Daily.Deceased) %>%
   dplyr::select(Confirmed, Recovered, Deceased)
 
N = 1341e6 # population size of India
data_initial = c(2059, 169, 58, 424, 9, 11)
pars_start = c(c(1,0.8,0.6,0.4,0.2), c(0.2,0.2,0.2,0.25,0.2))
phases = c(1,15,34,48,62)
 
 cov19pred = SEIRfansy.predict(data = train_multinom, init_pars = pars_start, 
                               data_init = data_initial, T_predict = 60, niter = 1e3, 
                               BurnIn = 1e2, data_test = test_multinom, model = "Multinomial", 
                               N = N, lambda = 1/(69.416 * 365), mu = 1/(69.416 * 365), 
                               period_start = phases, opt_num = 1, 
                               auto.initialize = TRUE, f = 0.15)

names(cov19pred)
class(cov19pred$prediction)
class(cov19pred$mcmc_pars)
names(cov19pred$plots)

plot(cov19pred, type = "trace")
plot(cov19pred, type = "boxplot")
plot(cov19pred, type = "panel")
plot(cov19pred, type = "cases")








# quick test for package check
# not for use outside CRAN check()
cov19est = SEIRfansy(data = train_multinom, init_pars = pars_start, 
                     data_init = data_initial, niter = 33, BurnIn = 18, 
                     model = "Multinomial", N = N, lambda = 1/(69.416 * 365), 
                     mu = 1/(69.416 * 365), period_start = phases, opt_num = 1, 
                     auto.initialize = TRUE, f = 0.15, plot = FALSE, system_test = NULL)

Package 'SEIRfansy'

Help Index

COVID-19 Cases Time Series in India

Description

Usage

Format

Examples

Plot an SEIRfansy Fit Object

Description

Usage

Arguments

Plot an SEIRfansyPredict Fit Object

Description

Usage

Arguments

Estimate SEIRfansy Model Parameters

Description

Usage

Arguments

Value

Examples

Prediction for SEIRfansy Model

Description

Usage

Arguments

Value

Examples