inst/rave-pipelines/template-rmd/debug.R

In raveio: File-System Toolbox for RAVE Project

##' Let RAVE switch to this module pipeline
##'
Sys.setenv("RAVE_PIPELINE" = normalizePath("TEMPLATE_PATH"))

##' Debug pipeline: assign variables to global environment
##' so that you can print them directly
##' setting `quick = FALSE` allows you to run the whole pipeline
##' including its parent pipelines. This is useful is the current
##' pipeline is a combination of multiple sub-pipelines
##'
raveio::pipeline_debug(quick = FALSE)
# raveio::pipeline_debug()

##' Visualize pipeline and the relationship between intermediate variables
##' This requires extra package `visNetwork`.
##' Please run `install.packages('visNetwork')` if missing packages
##'
raveio::pipeline_visualize()

##' Test run the pipeline in production mode
##'
# raveio::pipeline_run(async = TRUE)
raveio::pipeline_run()

##' Check pipeline progress to see status (cached/skipped, built, errored...)
##' Must run `raveio::pipeline_run()` first, otherwise error will occur
##'
raveio::pipeline_progress(method = 'details')


##' Get current variable table. Run `raveio::pipeline_run()` first
##'
raveio::pipeline_vartable()

##' Get intermediate variables
##'
raveio::pipeline_hasname("project_name")
raveio::pipeline_read("project_name")


##' Launch a shiny app to watch the pipeline. Please install extra
##' packages first:
##' `install.packages(c('bs4Dash', 'gt', 'pingr', 'shinybusy'))`
##'
raveio::pipeline_watch()


##' Some useful calls to add shortcuts to debug/run the pipeline
##' Check `?dipsaus::rs_add_shortcut` for details. Make sure in the pop-up
##' panel, search `dipsaus` and add shortcuts if necessary. Normally I would
##' do `alt(option)+1` and `alt(option)+2`
##'
##' Once the shortcuts are added, you can use `alt(option)+1` to debug the module,
##' and `alt(option)+2` to run the pipeline in production mode (non-interactive)

dipsaus::rs_add_shortcut(1, {
  raveio::pipeline_debug(quick = FALSE, env = .GlobalEnv)
})

dipsaus::rs_add_shortcut(2, {
  raveio::pipeline_run()
}, force = FALSE)