nmode's Git Repositories - Rnaught/blob - R/ID.R

   1 #' ID method
   2 #'
   3 #' This function implements a least squares estimation method of R0 due to Fisman et al. (PloS One, 2013).
   4 #' See details for implementation notes.
   5 #'
   6 #' The method is based on a straightforward incidence decay model. The estimate of R0 is the value which
   7 #' minimizes the sum of squares between observed case counts and cases counts 'expected' under the model.
   8 #'
   9 #' This method is based on an approximation of the SIR model, which is most valid at the beginning of an epidemic.
  10 #' The method assumes that the mean of the serial distribution (sometimes called the serial interval) is known.
  11 #' The final estimate can be quite sensitive to this value, so sensitivity testing is strongly recommended.
  12 #' Users should be careful about units of time (e.g. are counts observed daily or weekly?) when implementing.
  13 #'
  14 #' @param NT Vector of case counts
  15 #' @param mu Mean of the serial distribution (needs to match case counts in time units; for example, if case counts are
  16 #'           weekly and the serial distribution has a mean of seven days, then \code{mu} should be set to one, if case
  17 #'           counts are daily and the serial distribution has a mean of seven days, then \code{mu} should be set to seven)
  18 #'
  19 #' @return \code{ID} returns a list containing the following components:  \code{Rhat} is the estimate of R0 and
  20 #'         \code{inputs} is a list of the original input variables \code{NT, mu}.
  21 #'
  22 #' @examples
  23 #' ## ===================================================== ##
  24 #' ## Illustrate on weekly data                             ##
  25 #' ## ===================================================== ##
  26 #'
  27 #' NT <- c(1, 4, 10, 5, 3, 4, 19, 3, 3, 14, 4)
  28 #' ## obtain Rhat when serial distribution has mean of five days
  29 #' ID(NT=NT, mu=5/7)
  30 #' ## obtain Rhat when serial distribution has mean of three days
  31 #' ID(NT=NT, mu=3/7)
  32 #'
  33 #' ## ========================================================= ##
  34 #' ## Compute Rhat using only the first five weeks of data      ##
  35 #' ## ========================================================= ##
  36 #'
  37 #' ID(NT=NT[1:5], mu=5/7) # serial distribution has mean of five days
  38 #'
  39 #' @export
  40 ID <- function(NT, mu) {
  41     NT <- as.numeric(NT)
  42     TT <- length(NT)
  43     s <- (1:TT) / mu
  44     y <- log(NT) / s
  45
  46     R0_ID <- exp(sum(y) / TT)
  47
  48     return(R0_ID)
  49 }