get_model_metadata: Get Hub model metadata

View source: R/get_model_metadata.R

get_model_metadataR Documentation

Get Hub model metadata

Description

Get Hub model metadata

Usage

get_model_metadata(
  models = NULL,
  hub = c("US", "ECDC", "FluSight"),
  source = "local_hub_repo",
  hub_repo_path
)

Arguments

models

optional character vector of model abbreviations for which to retrieve designations. If not provided, the function returns model designations for all models.

hub

character, which hub to use. Options are "US", "ECDC" and "FluSight".

source

string specifying where forecasts will be loaded from: currently only supports "local_hub_repo"

hub_repo_path

path to local clone of the forecast hub repository

Value

data.frame with columns corresponding to any fieldnames in the metadata files from the queried models. NA represents an absence of data in that corresponding field. Two field names are changed from the raw metadata field names to align with get_model_designations() implementation: model_abbr is changed to model team_model_designation is changed to designation


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