R/ring_app_launch.R

In JingningShi/MtreeRing: A Shiny Application for Automatic Measurements of Tree-Ring Widths on Digital Images

#' @importFrom shiny actionButton checkboxInput div fileInput conditionalPanel
#' downloadButton downloadHandler helpText icon numericInput observeEvent
#' plotOutput reactiveValues renderPlot renderTable selectInput shinyApp
#' sliderInput tableOutput tabPanel textInput updateActionButton brushOpts
#' dblclickOpts column shinyAppDir
#' updateCheckboxInput updateTextInput hr br fluidRow
#' @importFrom shinydashboard dashboardHeader dashboardSidebar dashboardBody
#' dashboardPage sidebarMenu tabBox tabItem tabItems menuItem box
#' @importFrom  shinyWidgets prettySwitch prettyCheckbox prettyRadioButtons
#' radioGroupButtons sendSweetAlert updatePrettySwitch updatePrettyCheckbox
#' updatePrettyRadioButtons useSweetAlert colorSelectorInput
#' @importFrom utils write.csv
#' @importFrom dplR write.rwl
#' @title Run Shiny-based Application
#' @description Run a Shiny-based application within the system's default 
#' web browser.
#' @param launch.browser A logical value. 
#' If \code{FALSE}, a built-in browser will be launched automatically 
#' after the app is started. If \code{TRUE}, the system's default 
#' web browser is used instead. This argument only works for RStudio.
#' See details below.
#' 
#' @details
#' \code{launch.browser = FALSE} is not recommended, as the file renaming
#' does not work on the RStudio built-in browser when saving the data.
#' 
#' A workflow for the Shiny app can be found here:
#' \url{https://ropensci.github.io/MtreeRing/articles/app-MtreeRing.html}. 
#' Most steps are demonstrated with a gif
#' to make the workflow more understandable.
#' 
#' To stop the app, go to the R console and press the Escape key. 
#' You can also click the stop sign icon in the
#' upper right corner of the RStudio console.
#' @author Jingning Shi, Wei Xiang
#' @export


ring_app_launch <- function(launch.browser = TRUE) {
  app_dir <- system.file('mtr_app', package = 'MtreeRing')
  if (launch.browser) {
    shinyAppDir(app_dir, options = list(launch.browser = TRUE))
  } else {
    shinyAppDir(app_dir)
  }
  
}