R/ShinyApp.R

Defines functions ensure_installed launchQueryLibrary

Documented in launchQueryLibrary

# Copyright 2019 Observational Health Data Sciences and Informatics
#
# This file is part of QueryLibrary
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
#     http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#' Launch the SqlRender Developer Shiny app
#' 
#' @param launch.browser    Should the app be launched in your default browser, or in a Shiny window.
#'                          Note: copying to clipboard will not work in a Shiny window.
#' 
#' @details 
#' Launches a Shiny app that allows the user to select queries from the library and run these against a CDM
#' 
#' @export
launchQueryLibrary <- function(launch.browser = TRUE) {
  ensure_installed("shinydashboard")
  ensure_installed("shinyjs")
  ensure_installed("shinyFiles")
  ensure_installed("glue")
  ensure_installed("SqlRender")
  ensure_installed("DatabaseConnector")
  ensure_installed("DT")
  appDir <- system.file("shinyApps", "QueryLibrary", package = "QueryLibrary")
  shiny::runApp(appDir, display.mode = "normal", launch.browser = launch.browser)
}

# Borrowed from devtools: https://github.com/hadley/devtools/blob/ba7a5a4abd8258c52cb156e7b26bb4bf47a79f0b/R/utils.r#L44
is_installed <- function (pkg, version = 0) {
  installed_version <- tryCatch(utils::packageVersion(pkg), 
                                error = function(e) NA)
  !is.na(installed_version) && installed_version >= version
}

# Borrowed and adapted from devtools: https://github.com/hadley/devtools/blob/ba7a5a4abd8258c52cb156e7b26bb4bf47a79f0b/R/utils.r#L74
ensure_installed <- function(pkg) {
  if (!is_installed(pkg)) {
    msg <- paste0(sQuote(pkg), " must be installed for this functionality.")
    if (interactive()) {
      message(msg, "\nWould you like to install it?")
      if (menu(c("Yes", "No")) == 1) {
        install.packages(pkg)
      } else {
        stop(msg, call. = FALSE)
      }
    } else {
      stop(msg, call. = FALSE)
    }
  }
}
OHDSI/QueryLibrary documentation built on Aug. 1, 2023, 5:42 a.m.