get_candidate_models: Get a list of candidate models with specified model...

View source: R/qra_fit_convenience.R

get_candidate_modelsR Documentation

Get a list of candidate models with specified model designations

Description

Get a list of candidate models with specified model designations

Usage

get_candidate_models(
  submissions_root,
  include_designations = c("primary", "secondary", "proposed"),
  include_COVIDhub_ensemble = FALSE,
  include_COVIDhub_baseline = TRUE
)

Arguments

submissions_root

path to the data-processed folder of the covid19-forecast-hub repository

include_designations

character vector of model designations to include: "primary", "secondary", "proposed", and/or "other"

include_COVIDhub_ensemble

logical: if TRUE, whether or not the COVIDhub-ensemble model is included depends on whether it falls within one of the specified include_designations; if FALSE, it will never be included

include_COVIDhub_baseline

logical: if TRUE, whether or not the COVIDhub-baseline model is included depends on whether it falls within one of the specified include_designations; if FALSE, it will never be included

Value

character vector of model abbreviations


reichlab/covidEnsembles documentation built on Jan. 31, 2024, 7:21 p.m.