R/run.R

In crp2a/gammaShiny: 'shiny' Applications for the R Package 'gamma'

# SHINY

#' Run a Shiny App
#'
#' A wrapper for [shiny::shinyAppDir()].
#' @param app A [`character`] string specifying the Shiny application
#'  to run. It must be one of "`doserate`" or "`calibration`"
#'  (see details). Any unambiguous substring can be given.
#' @param browser A [`logical`] scalar: should the app be run in
#'  the browser?
#' @param display A [`character`] string specifying the mode in which
#'  to display the application (see [shiny::runApp()]).
#' @details
#'  \tabular{ll}{
#'   **Application name** \tab  **Keyword** \cr
#'   Dose rate estimation \tab `doserate` \cr
#'   Calibration curve builder \tab `calibration` \cr
#'  }
#' @examples
#' \dontrun{
#' run_app("doserate")
#' run_app("calibration")
#' }
#' @note
#'  Usefull presets for the energy scale calibration:
#'  \tabular{ll}{
#'   Channel \tab Energy (keV) \cr
#'   76 \tab 238.63 \cr
#'   465 \tab 1460.82 \cr
#'   830 \tab 2614.51 \cr
#'  }
#' @return A \pkg{shiny} application object.
#' @family shiny
#' @author N. Frerebeau
#' @export
run_app <- function(app = c("doserate", "calibration"),
                    browser = TRUE, display = "auto") {
  app <- match.arg(app, several.ok = FALSE)
  if (app == "calibration") stop("Work in progress!", call. = FALSE)
  app_dir <- system.file(app, package = "gammaShiny")
  if (app_dir == "")
    stop(sprintf("Could not find %s app. ", sQuote(app)),
         "Try re-installing 'gammaShiny'.", call. = FALSE)
  shiny::shinyAppDir(
    appDir = app_dir,
    options = list(launch.browser = browser, display.mode = display)
  )
}

#' @rdname run_app
#' @export
launch_app <- run_app