load_forecasts_repo: Load all available forecasts submitted on 'forecast_dates'...

In reichlab/covidHubUtils: Utility functions for the COVID-19 forecast hub

Load all available forecasts submitted on forecast_dates from a local clone of reichlab/covid19-forecast-hub repo.

Description

This function will throw an error when no forecasts are submitted on any dates in forecast_dates for selected models, locations, types and target.

Usage

load_forecasts_repo(
  file_path,
  models = NULL,
  forecast_dates = NULL,
  locations = NULL,
  types = c("point", "quantile"),
  targets = NULL,
  hub = c("US", "ECDC", "FluSight"),
  verbose = TRUE
)

Arguments

file_path	path to the data-processed folder within a local clone of the hub repo
models	Character vector of model abbreviations. Default all models that submitted forecasts meeting the other criteria.
forecast_dates	A 2 dimensional list of forecast dates to retrieve forecasts. This function will return the latest forecasts for each sub-list of dates. Default to NULL which would include all valid forecast dates. The function will throw an error if all dates in this parameter are invalid forecast dates.
locations	a vector of strings of fips code or CBSA codes or location names, such as "Hampshire County, MA", "Alabama", "United Kingdom". A US county location names must include state abbreviation. Default to NULL which would include all locations with available forecasts.
types	Character vector specifying type of forecasts to load: "quantile" and/or "point". Default to all valid forecast types.
targets	character vector of targets to retrieve, for example c('1 wk ahead cum death', '2 wk ahead cum death'). Default to NULL which stands for all valid targets.
hub	character vector indicating the hub from which to load forecasts. Possible options are "US", "ECDC" and "FluSight".
verbose	logical to print out diagnostic messages. Default is TRUE

Details

This function will drop rows with NULL in value column.

Value

data.frame with columns model, forecast_date, location, horizon, temporal_resolution, target_variable, target_end_date, type, quantile, value, location_name, population, geo_type, geo_value, abbreviation

reichlab/covidHubUtils documentation built on Feb. 6, 2024, 1:42 p.m.