R/shiny_app.R

In crukci-bioinformatics/rascal: Shiny app and functions for scaling relative copy number data to absolute values

#' Shiny app for absolute copy number scaling
#'
#' Starts the shiny app in a new tab in the the default web browser.
#' If a browser tab isn't opened it may be necessary to manually open the
#' URL shown in the console.
#'
#' @param load_sample_data load a sample data set on starting the Shiny app.
#' @param launch_browser launch the application in a web browser on starting the
#' Shiny app.
#' @param host The IPv4 address that the application should listen on. Defaults
#' to the shiny.host option, if set, or "127.0.0.1" if not. The default value of
#' "127.0.0.1" will only allow the current machine to access the Shiny app; set
#' to "0.0.0.0" to allow other clients to connect.
#' @param port the TCP port that the application should listen on.
#' @return opens the Shiny app in a web browser.
#' @import shiny
#' @export
start_shiny_app <- function(load_sample_data = TRUE, launch_browser = TRUE, host = getOption("shiny.host", "127.0.0.1"), port = getOption("shiny.port")) {
  dir <- system.file("shiny", package = "rascal")
  if (dir == "") stop("Could not find shiny app directory in the rascal package")
  shiny::shinyOptions(load_sample_data = load_sample_data)
  shiny::runApp(dir, host = host, port = port, launch.browser = launch_browser, display.mode = "normal")
}