run_example: Run example of package

Description Usage Arguments Value Examples

View source: R/WRAPPER_run_example.R

Description

run_example is a function to run an example of the application of the tsforecast package on a public (time series) dataset. Calling the function will start an interactive Shiny dashboard that enables exploration of the individual forecasts versus actuals per split date, as well as an analysis of the overall forecast accuracy of the different forecast models.

Usage

1
2
3
4
run_example(
  dataset = c("AirPassengers", "nottem", "UKDriverDeaths", "hierarchical"),
  test_mode = F
)

Arguments

dataset

A character string indicating which of the available public (time series) datasets to show in the example.

test_mode

Boolean, which is only set to TRUE when testing this function within the testthat framework for building the tsforecast package.

Value

An interactive Shiny dashboard.

Examples

1
2
3
4
run_example(dataset = "AirPassengers")
run_example(dataset = "nottem")
run_example(dataset = "UKDriverDeaths")
run_example(dataset = "hierarchical")

ing-bank/tsforecast documentation built on Sept. 18, 2020, 9:40 a.m.