Function reference • EpiSoon

Analysis wrappers

Functions that wrap multiple steps to allow end to end forecasting analyses

evaluate_model(): Evaluate a Model for Forecasting Rts

compare_models(): Compare forecasting models

compare_timeseries(): Compare timeseries and forecast models

Forecast

Forecasting tools

forecast_model(): forecast Model Wrapper

forecast_rt(): Fit and Forecast using a Model

forecast_cases(): Forecasts Cases for a Rt Forecasts

forecast_cases_directly(): Forecasts Cases Directly

iterative_rt_forecast(): Iteratively Forecast

iterative_case_forecast(): Iteratively Forecast Cases Using an Iterative Rt Forecast

iterative_direct_case_forecast(): Iteratively forecast directly on cases

Model Wrappers

Functions that allow models from other packages to be used.

bsts_model(): bsts Model Wrapper

fable_model(): fable Model Wrapper

brms_model(): brms Model Wrapper

forecastHybrid_model(): forecastHybrid Model Wrapper

stackr_model(): Stack Models According to CRPS

Predicting cases from reproduction numbers

Functions to for mapping reproduction number estimates to forecast cases

predict_cases(): Predict cases for a single Rt sample forecasts

predict_current_cases(): Predict cases for Rts based on observed data

draw_from_si_prob(): Draw from the Serial Interval Probability Distribution

Score forecasts

Functions to score forecasts

score_forecast(): Score a Model Fit

score_case_forecast(): Score a case forecast

Summary functions

Tools to summarise forecasts and scores

summarise_forecast(): Summarise Forecast Rts

summarise_case_forecast(): Summarise Forecast Cases

summarise_scores(): Summarise model forecasting scores

Plotting functions

Tools to plot forecasts

plot_forecast(): Plot a Forecast

plot_compare_timeseries(): Summary plots to compare timeseries and forecast models

plot_forecast_evaluation(): Plot a Forecast

plot_scores(): Plot forecast scores

Example datasets

Example datasets used in the package.

example_obs_cases: Example Observed Cases

example_obs_rts: Example Observed Rts

example_serial_interval: Example Serial Interval