R/data.R

In ERRI: Economic Resilience and Recovery Index

#' Example regional economic data
#'
#' Reads the reproducible example data installed with the package. The data
#' contain annual real-income indices for three fictional regions from 2010
#' through 2025, with a disruption beginning in 2020 and heterogeneous
#' recovery paths.
#'
#' @return A data frame with `region`, `year`, and `income`.
#' @export
#' @examples
#' dat <- erri_example_data()
#' head(dat)
erri_example_data <- function() {
    path <- system.file("extdata", "regional_economy.csv", package = "ERRI")
    if (!nzchar(path)) .erri_stop("Example data file was not installed.")
    utils::read.csv(path, stringsAsFactors = FALSE)
}