R/get_fit.R

Defines functions get_fit.incidence_fit_list get_fit.incidence_fit get_fit

Documented in get_fit get_fit.incidence_fit get_fit.incidence_fit_list

#' Accessors for `incidence_fit` objects
#' 
#' @param x an `incidence_fit` or `incidence_fit_list`
#'   object.
#' @return a list of `incidence_fit` objects. 
#' @export
#' @examples
#' 
#' if (require(outbreaks)) { withAutoprint({
#' 
#'  dat <- ebola_sim$linelist$date_of_onset
#'
#'  ## EXAMPLE WITH A SINGLE MODEL
#'
#'  ## compute weekly incidence
#'  sex <- ebola_sim$linelist$gender
#'  i.sex <- incidence(dat, interval = 7, group = sex)
#'  
#'  ## Compute the optimal split for each group separately
#'  fits  <- fit_optim_split(i.sex, separate_split = TRUE)
#'
#'  ## `fits` contains an `incidence_fit_list` object
#'  fits$fit
#'  
#'  ## Grab the list of `incidence_fit` objects
#'  get_fit(fits$fit)
#'  
#'  ## Get the predictions for all groups
#'  get_info(fits$fit, "pred", groups = 1)
#'  
#'  ## Get the predictions, but set `groups` to "before" and "after"
#'  get_info(fits$fit, "pred", groups = 2)
#'  
#'  ## Get the reproduction number
#'  get_info(fits$fit, "r")
#'
#'  ## Get the doubling confidence interval
#'  get_info(fits$fit, "doubling.conf")
#'
#'  ## Get the halving confidence interval
#'  get_info(fits$fit, "halving.conf")
#' })}
get_fit <- function(x) {
  UseMethod("get_fit")
}

#' @rdname get_fit
#' @export
get_fit.incidence_fit <- function(x) {
  x
}

#' @rdname get_fit
#' @export
get_fit.incidence_fit_list <- function(x) {
  locations <- attr(x, "locations")
  res <- lapply(locations, function(i) x[[i]])
  names(res) <- vapply(locations, paste, character(1), collapse = "_")
  res
}

Try the incidence package in your browser

Any scripts or data that you put into this service are public.

incidence documentation built on Nov. 30, 2018, 4:23 p.m.