format_forecast: Format Forecasts

View source: R/format_forecast.R

format_forecastR Documentation

Format Forecasts

Description

Format Forecasts

Usage

format_forecast(
  forecasts,
  locations,
  forecast_date = NULL,
  submission_date = NULL,
  CrI_samples = 1,
  frequency = "daily",
  target_value = NULL,
  max_value = 1e+07
)

Arguments

forecasts

A data frame of forecasts containing the following variables: date, value, region, and sample.

locations

A data frame data dictionary linking locations with location names. Must contain: location and location_name

forecast_date

A date indicating when the forecast took place.

submission_date

A date indicating the target submission date.

CrI_samples

A fraction of the posterior samples to include. Defaults to 1. Can be helpful for models that have more uncertainty than is reasonable.

target_value

Character string indicating the target value name.

max_value

Integer indicating the maximum forecast value allowed. Defaults to 10 million.

Value

A data frame


epiforecasts/europe-covid-forecast documentation built on Jan. 15, 2025, 8:57 p.m.