inst/dev/build_helpers.R

In animate: A Web-Based Graphics Device for Animated Visualisations

#' #' Build and configure the application
#' build <- function(stack_size = 0, debug = FALSE, keep = FALSE) {
#'   if (basename(getwd()) != "animate") {
#'     stop("You seem to be in the wrong folder to call this function.")
#'   }
#'   curwd <- getwd()
#'   on.exit(setwd(curwd))
#'   # Need to go to the main directory for compiling the R files into JS files
#'   message("Building the app...")
#'   setwd("./inst/src/")
#'   lines <- readLines("plot.R")
#'   lines <- append(lines, "#! load_library('websocket')", 4)
#'   lines <- append(lines, "#! load_script('message.R')", 5)
#'   lines <- append(lines, "#! load_script('../addons/screen_record.js')", 6)
#'   lines <- append(lines, glue::glue("JS_device <- plot2$new({stack_size})"))
#'
#'   message("Writing to ", file.path("./inst/src", "dist.R"))
#'   write(lines, "dist.R")
#'
#'   message("Writing to ", file.path("./inst/dist", "animate.html"))
#'   res <- file.copy(
#'     from = sketch::source_r("dist.R", debug = debug, launch_browser = NULL),
#'     to = "../dist/animate.html",
#'     overwrite = T
#'   )
#'
#'   if (!keep) {
#'     message("Cleaning up ", file.path("./inst/src", "dist.R"))
#'     file.remove("./dist.R")
#'   }
#'
#'   res
#' }
#'
#'
#' #' Build shiny
#' build_shiny <- function(shiny_helper_file) {
#'   message("Writing to ./inst/dist/shiny.js")
#'   compile_r(shiny_helper_file, "./inst/dist/shiny.js")
#' }
#'
#'
#' #' Build inline rmarkdown
#' build_virtual_device <- function(file) {
#'   message("Writing to ./inst/dist/virtual_device.js")
#'   compile_r(file, "./inst/dist/virtual_device.js")
#' }
#'
#'
#' #' Build a library
#' #'
#' #' @param main_file A character string; the file path to the app file.
#' #'
#' #' @export
#' build_library <- function(main_file) {
#'   # The bundled file should contain all the dependencies of the main file 'plot.R',
#'   # and then the main file itself.
#'   if (!file.exists(main_file)) {
#'     stop("File '", main_file, "' does not exist.")
#'   }
#'   dep <- sketch::get_dependencies(main_file)
#'
#'   message("Building the library...")
#'   curwd <- getwd()
#'   on.exit(setwd(curwd))
#'   src_path <- dirname(main_file)
#'   setwd(src_path)
#'
#'   js <- sketch::bundle(c(sketch::src("dom"), sketch::src("io"), dep, basename(main_file)))
#'   message("Writing to ./inst/dist/animate.js")
#'   file.copy(js, "../dist/animate.js", overwrite = TRUE)
#' }