| Title: | Example Hub Data |
|---|---|
| Description: | This package provides example data for forecasting and scenario modeling hubs in the hubverse format. |
| Authors: | Evan L Ray [aut, cre],
Becky Sweger [aut],
Lucie Contamin [aut] |
| Maintainer: | Evan L Ray <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.0.1 |
| Built: | 2024-10-18 06:17:10 UTC |
| Source: | https://github.com/hubverse-org/hubExamples |
The hubExamples package provides three data sets that contain example model output and
target data for an example forecast hub: forecast_outputs, forecast_target_ts, and
forecast_target_observations.
forecast_outputs contains example forecast data that represents model outputs from a forecast hub
with predictions for three influenza-related targets (wk inc flu hosp, wk flu hops rate category,
and wk flu hosp rate) for two reference dates in 2022. This dataset reflect forecast outputs as they look
when retrieved from a hub via the hubData package (which is slightly different than they look
when originally submitted by modelers).
forecast_target_ts contains time series target data from a hub that predicts influenza-related targets.
forecast_target_observations contains target data that represents the source of "truth" that model output data
will be scored against. This example represents influenza-related targets.
forecast_outputs forecast_target_ts forecast_target_observationsforecast_outputs forecast_target_ts forecast_target_observations
forecast_outputsA data frame with 5,424 rows and 9 columns:
FIPS code identifying a location
the starting point of the forecast in yyyy-mm-dd format
number of time units ahead being forecasted relative to the
reference_date, in units of weeks
the date of occurrence of the outcome of interest in yyyy-mm-dd format;
this can be calculated directly from the reference_date and horizon
as follows: target_end_date = reference_date + 7*horizon
a unique identifier for the target
the type of representation of the prediction
more identifying information specific to the output type;
output_type_id is not relevant for every kind of output_type (for example,
hubs will not expect output_type_id values when the output_type is mean or median
the model’s prediction
the name of the model
forecast_target_tsA data frame with 10,255 rows and 3 columns:
the date of the target observation in yyyy-mm-dd format
FIPS code identifying a location
a count of hospital admissions in the given location
in the week ending on the given date.
forecast_target_observationsA data frame with 198,485 rows and 6 columns:
FIPS code identifying a location
the target's observation date in yyyy-mm-dd format;
this is used to match on the target_end_date field in model output data
submitted to the hub
a unique identifier for the target
the type of representation of the prediction
more identifying information specific to the output type;
as in the model output data, output_type_id is not relevant for output_type
of mean and median; target data that represents quantile output_type will
not have an output_type_id.
the observed value of the target
https://github.com/hubverse-org/example-complex-forecast-hub/
The hubExamples package provides two data sets that contain example model output and
target data for an example scenario hub: scenario_outputs and scenario_target_ts.
scenario_outputs contains example scenario projection data that represents
model outputs and an ensemble from a scenario hub with predictions for one
target (inc hosp) in one location ("US"), one round ("2021-03-07") and
four scenarios. This dataset reflects scenario projection outputs as they look
when retrieved from a hub via the hubData package (which is slightly
different than they look when originally submitted by modelers), and with
a "mean" ensemble calculated with the hubEnsemble package
simple_ensemble() function with default parameters.
The date of occurrence of the outcome of interest in yyyy-mm-dd format
can be calculated directly from the origin_date and horizon as follows:
target_end_date = origin_date + (7 * horizon) - 1
scenario_target_ts contains time series target data associated with the
scenario projection data.
scenario_outputs scenario_target_tsscenario_outputs scenario_target_ts
scenario_outputsA data frame with 7,176 rows and 9 columns:
the name of the model
the starting point of the projection in yyyy-mm-dd format
a unique identifier for the scenario
FIPS code identifying a location
a unique identifier for the target
number of time units ahead being projected relative to the
origin_date, in units of weeks
the type of representation of the prediction; in this
example, all values for the output_type are "quantile".
more identifying information specific to the
output type; here, the output_type_id specifies the probability
level for the quantile prediction
the model’s prediction
scenario_target_tsA data frame with 127 rows and 3 columns:
FIPS code identifying a location
the date of the target observation in yyyy-mm-dd format
a count of incident cases in the given location
in the week ending on the given date.
a unique identifier for the target
https://github.com/hubverse-org/example-complex-scenario-hub/