R/get_pop_size.R

Defines functions get_pop_size.epiflows get_pop_size

Documented in get_pop_size get_pop_size.epiflows

#' Get population size for each entry in locations
#' 
#' @param x an epiflows object
#' @return a named vector of population sizes
#' @export
#' @md
#' @seealso [get_vars()], [global_vars()]
#'
#' @examples
#' data("Brazil_epiflows")
#' get_pop_size(Brazil_epiflows)
get_pop_size <- function(x) {
  UseMethod("get_pop_size")
}

#' @rdname get_pop_size
#' @export
get_pop_size.epiflows <- function(x) {
  get_vars(x, "pop_size", id = FALSE, vector = TRUE)
}

Try the epiflows package in your browser

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

epiflows documentation built on April 10, 2023, 5:06 p.m.