R/app_launch.R

In mapmixture: Spatial Visualisation of Admixture on a Projected Map

#' Launch Shiny App
#'
#' @description
#' Wrapper function used to start `mapmixture` interactive app.
#'
#' App tested with the following package versions:
#'
#' shiny v1.8.0,
#' shinyFeedback v0.4.0,
#' shinyjs v2.1.0,
#' shinyWidgets 0.8.4,
#' bslib 0.7.0,
#' colourpicker 1.3.0,
#' htmltools v0.5.8.1,
#' waiter 0.2.5.
#'
#' @param ... additional arguments passed to `shiny::runApp()`.
#'
#' @return No return value.
#' @export
#'
#' @examples
#' if (interactive()){
#'   launch_mapmixture(launch.browser = TRUE)
#' }
launch_mapmixture <- function(...) {

  # List of required packages
  required_packages <- c(
    "shiny", "shinyFeedback", "shinyjs", "shinyWidgets",
    "bslib", "colourpicker", "htmltools", "waiter"
  )

  # Check for missing packages
  missing_packages <- setdiff(required_packages, utils::installed.packages()[, "Package"])

  # If there are missing packages, stop and inform the user
  if (length(missing_packages) > 0) {
    stop(
      "The following packages are required but not installed: ",
      paste(missing_packages, collapse = ", "),
      ". Please install them before running `launch_mapmixture()`.",
      "See help documentation for recommended package versions. ",
      "To install Shiny version 1.8.0 from source: `install.packages('https://cran.r-project.org/src/contrib/Archive/shiny/shiny_1.8.0.tar.gz', repos = NULL, type = 'source')`."
    )
  }

  # Check Shiny version if already installed (tested with version 1.8.0)
  if (utils::packageDescription("shiny")$Version != "1.8.0") {
    warning(
      "App functionality tested with Shiny version 1.8.0. App may not work as expected for other Shiny versions. ",
      "To install Shiny version 1.8.0 from source: `install.packages('https://cran.r-project.org/src/contrib/Archive/shiny/shiny_1.8.0.tar.gz', repos = NULL, type = 'source')`.",
      immediate. = TRUE
    )
  }

  # Launch app
  shiny::shinyApp(
    ui = app_ui,
    server = app_server,
    options = list(...)
  )
}