run_ensemble: Run ensembling methods

View source: R/run_ensemble.R

run_ensembleR Documentation

Run ensembling methods

Description

Run ensembling methods

Usage

run_ensemble(
  method = "mean",
  forecast_date,
  exclude_models = NULL,
  min_nmodels = 0,
  return_criteria = TRUE,
  verbose = FALSE,
  exclude_designated_other = TRUE,
  identifier = "",
  rel_wis_cutoff = Inf,
  ...
)

Arguments

method

name of ensembling method

forecast_date

date or character

exclude_models

optional character vector to exclude over all dates, or data.frame with cols model and forecast_date, to exclude for specific dates

min_nmodels

minimum number of models to create an ensemble

return_criteria

logical : whether to return a model/inclusion criteria grid as well as the ensemble forecast (default TRUE)

verbose

Logical determining whether diagnostic messages should be printed while running (defaults to FALSE).

exclude_designated_other

logical: whether to exclude models designated as "other" in their metadata file (default TRUE)

identifier

an identifier to prepend to each model name

rel_wis_cutoff

numeric: any model with relative WIS greater than this value will be excluded

...

arguments passed to create_ensemble_relative_skill()

Details

Used to create a single ensemble forecast. Takes a forecast date and loads all forecasts for the preceding week, then: Filters models according to criteria Ensembles forecasts according to given method Formats ensemble forecast Returns ensemble forecast and optionally the criteria for inclusion


covid19-forecast-hub-europe/EuroForecastHub documentation built on July 2, 2023, 3:03 p.m.