R/shinybox.R

In ocelhay/shinybox: Create Standalone R-Shiny Apps

#' shinybox
#'
#' @param app_name Must be lowercase and one word, and may contain hyphens and underscores.
#' @param author Author of the app.
#' @param description Short app description.
#' @param semantic_version Must be in the form x.x.x and follow the semantic versioning guidelines - https://docs.npmjs.com/about-semantic-versioning.
#' @param cran_like_url url to cran-like repository. Default value is https://cran.r-project.org. 
#'     To use MRAN, set to "https://cran.microsoft.com/snapshot/2021-01-10" with desired date. (TODO: what about RStudio package repository?)
#' @param mac_file file path to mac OS tar.gz. Might need to use option 1 of https://www.technipages.com/macos-disable-appname-cant-be-opened-because-it-is-from-an-unidentified-developer
#'     Example: "/Users/olivier/Documents/Ressources Pro/R/macOS targz/R-4.1-branch.tar.gz",
#' @param mac_r_url url to mac OS tar.gz  ("https://mac.r-project.org/high-sierra/R-4.1-branch/x86_64/R-4.1-branch.tar.gz"). Only used if mac_file is NULL.
#' @param git_host one of c("github", "gitlab", "bitbucket")
#' @param git_repo GitHub/Bitbucket/GitLab username/repo of the shiny-app package (e.g. 'ocelhay/shinyboxtestapp',  'acornamr/acorn-dashboard@development'). 
#' @param local_package_path path to local shiny-app package, if 'git_package' isn't used 
#' @param function_name the function name in your package that starts the shiny app
#' @param package_install_opts optional arguments passed to remotes::install_github, install_gitlab, install_bitbucket, or install_local
#' @param build_path Path where the build files will be created, preferably points to an empty directory.
#' @param rtools_path_win path to RTools (Windows only)
#' @param nodejs_path path to nodejs
#' @param run_build logical, whether to start the build process, helpful if you want to modify anthying before building
#'
#' @export
#'
shinybox <- function(app_name = "HAL",
                     author = "Stanley K.",
                     description = "Heuristically Programmed ALgorithmic Computer",
                     semantic_version = "v9000.0.0",
                     cran_like_url = "https://cran.r-project.org",
                     mac_file = NULL,
                     mac_r_url = NULL,
                     git_host = "github",
                     git_repo = "ocelhay/shinybox/misc/shinyboxtestapp",
                     local_package_path = NULL,
                     function_name = "run_app",
                     package_install_opts = NULL,
                     build_path = NULL,
                     rtools_path_win = NULL,
                     nodejs_path = NULL,
                     run_build = TRUE) {
  
  sys_os <- switch(Sys.info()["sysname"],
               "Darwin" = "mac",
               "Windows" = "win")
  
  # check function arguments and fail early if something is wrong. ----
  check_first(os = sys_os,
              app_name,
              semantic_version,
              function_name,
              nodejs_path,
              package_install_opts,
              build_path,
              cran_like_url, 
              git_host,
              git_repo,
              local_package_path)
  
  # check Node.js and npm. ----
  check_nodejs_npm(os = sys_os, node_top_dir = nodejs_path)
  
  # copy Electron app template into the build path. ----
  dirs <- system.file("template", package = "shinybox")
  dirs <- list.dirs(dirs)[-1]
  file.copy(dirs, build_path, recursive = TRUE)
  
  # edit package.json (Electron app template). ----
  package_json <- rjson::fromJSON(file = system.file("template/package.json", package = "shinybox"))
  
  package_json$name <- app_name
  package_json$description <- description
  package_json$version <- semantic_version
  package_json$author <- author
  package_json$build$appId <- glue::glue("com.{app_name}")
  
  package_json <- rjson::toJSON(package_json, indent = 2)
  write(package_json, glue::glue("{build_path}/package.json"))
  
  # install R in the build path. ----
  message("Install R.")
  install_r(os = sys_os,
            cran_like_url = cran_like_url,
            build_path = build_path,
            mac_file = mac_file,
            mac_r_url = mac_r_url)
  
  
  # Find Electron app's R's library folder ----------------------------------
  if (identical(sys_os, "win")) {
    library_path <- file.path(build_path, "app", "r_lang", "library")
  }
  
  if (identical(sys_os, "mac")) {
    library_path <- file.path(build_path, "app/r_lang/Library/Frameworks/R.framework/Versions")
    library_path <-  list.dirs(library_path, recursive = FALSE)
    library_path <- library_path[grep("\\d+\\.(?:\\d+|x)(?:\\.\\d+|x){0,1}", library_path)][[1]]
    library_path <- file.path(library_path, "Resources/library")
  }
  
  # Install shiny app/package and dependencies ------------------------------
  message("Install shiny app/package and dependencies")
  if (!is.null(git_host)) {
    my_package_name <-  install_user_app(os = sys_os,
                                         library_path = library_path,
                                         repo_location = git_host,
                                         repo = git_repo,
                                         repos = cran_like_url,
                                         package_install_opts = package_install_opts,
                                         rtools_path_win = rtools_path_win)
  }
  
  
  if (!is.null(local_package_path)) {
    my_package_name <- install_user_app(os = sys_os,
                                        library_path = library_path ,
                                        repo_location = "local",
                                        repo = local_package_path,
                                        repos = cran_like_url,
                                        package_install_opts = package_install_opts,
                                        rtools_path_win = rtools_path_win)
  }
  
  message("Trim R's size.")
  trim_r(build_path = build_path)
  
  message("Transfer and overwrite existing icons if present.")
  electron_build_resources <- system.file("icons", 
                                          package = my_package_name, 
                                          lib.loc = library_path)
  
  if (nchar(electron_build_resources) > 0) {
    electron_build_resources <- list.files(electron_build_resources, full.names = TRUE)
    resources <- file.path(build_path, "resources")
    file.copy(from = electron_build_resources, to = resources, overwrite = TRUE)
  }
  
  # Add function that runs the shiny app to description.js ------------------
  modify_background_js(background_js_path = file.path(build_path, "src", "background.js"),
                       my_package_name = my_package_name,
                       function_name = function_name,
                       r_path = dirname(library_path))
  
  
  # Build the electron app --------------------------------------------------
  ifelse(run_build, 
         run_build_release(os = sys_os,
                           nodejs_path = nodejs_path,
                           build_path = build_path),
         message("Build step was skipped. When you are ready to build the distributable run 'run_build_release(...)'")
  )
}