forecast_dates
from Zoltar.R/load_forecasts_zoltar.R
load_forecasts_zoltar.Rd
This function will throw a warning and return empty data.frame when
no forecasts are submitted on any dates in forecast_dates
for selected models
,
locations
, types
and target
.
load_forecasts_zoltar(
models = NULL,
forecast_dates = NULL,
locations = NULL,
types = NULL,
targets = NULL,
as_of = NULL,
hub = c("US", "ECDC"),
verbose = TRUE
)
Character vector of model abbreviations. Default all models that submitted forecasts meeting the other criteria.
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 in Zoltar.
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 in Zoltar.
Character vector specifying type of forecasts to load: "quantile"
and/or "point"
. Default to all valid forecast types in Zoltar.
character vector of targets to retrieve, for example
c('1 wk ahead cum death', '2 wk ahead cum death')
.
Default to all valid targets in Zoltar.
character for date time to load forecasts submitted as of this time.
It could use the format of one of the three examples:
"2021-01-01", "2020-01-01 01:01:01" and "2020-01-01 01:01:01 UTC".
If you would like to set a timezone, it has to be UTC now.
If not, helper function will append the default timezone to your input based on hub
parameter.
Default to NULL
to load the latest version.
character vector, where the first element indicates the hub
from which to load forecasts. Possible options are "US"
and "ECDC"
.
logical for printing messages on zoltar job status. Default to TRUE
.
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