R/run_app.R

In forecastsuite: Multi-Model Time Series Forecasting Toolkit and Local App

#' Launch the bundled local forecastsuite Shiny app
#'
#' Unlike the hosted Forecast Dashboard app, this exposes every registered,
#' available model (Prophet, ARIMA, SARIMA, ETS, TBATS, NNETAR, Holt-Winters,
#' and LSTM if `torch` is installed) with Plotly always on and no
#' memory-conserving toggles, since it targets local/offline use rather than
#' a free hosting tier.
#'
#' The Data Import tab's "Global environment" source only reads data frames;
#' it never writes. By default it lists them from the global environment.
#' Set `options(forecastsuite.data_env = <environment>)` to point it at a
#' different environment instead.
#'
#' @param ... Passed through to `shiny::shinyApp(options = list(...))`.
#'
#' @return A `shiny.appobj`, as returned by `shiny::shinyApp()`. Printing it
#'   (e.g. calling `run_app()` at the console, or letting it auto-print)
#'   launches the app; it does not block on its own.
#' @export
#' @examples
#' if (interactive()) {
#'   run_app()
#' }
run_app <- function(...) {
  shiny::addResourcePath("fs-www", system.file("www", package = "forecastsuite"))
  shiny::shinyApp(ui = build_app_ui(), server = build_app_server, options = list(...))
}