shortcuts.R

In dipterix/dipsaus: A Dipping Sauce for Data Analysis and Visualizations

#' Enables quick debug.
#' Tired of running debugging code? Save this shortcut
#' To set debug code, write down debugging code in the following format
#' To run the code, use shortcut. make sure the cursor pointer is below the
#' flag `DIPSAUS DEBUG START`. Try to click anywhere below line 8 and activate
#' shortcut 1 (alt+1)

# DIPSAUS DEBUG START
# message("This is a debug message")
dipsaus::rs_add_shortcut(1, {
  local({
    tik <- Sys.time()
    dipsaus::rs_quick_debug()
    tok <- Sys.time()
    message("Exec time: ", format(tok - tik))
  })
})

#' Save current workspace to a temporary place for quick debugging when
#' switching between R sessions
dipsaus::rs_add_shortcut(4, {
  local({
    image_path <- file.path(tools::R_user_dir(package = "dipsaus", which = "cache"), "temporary")
    if(!dir.exists(image_path)) {
      dir.create(image_path, showWarnings = FALSE, recursive = TRUE)
    }
    image_path <- file.path(image_path, "snapshot.RData")
    message("Saving current workspace to: ", image_path)
    save.image(file = image_path)
  })
})

#' Load workspace saved by the previous shortcut
dipsaus::rs_add_shortcut(5, {
  local({
    image_path <- file.path(tools::R_user_dir(package = "dipsaus", which = "cache"), "temporary", "snapshot.RData")
    if(file.exists(image_path)) {
      message("Loading saved workspace from: ", image_path)
      load(image_path, envir = globalenv(), verbose = TRUE)
    }
  })
})

#' Insert operator `%<-?%`. This operator requires `dipsaus` to be loaded.
#' It assigns the right-hand data to the left-hand variable if the
#' right-hand variable is valid and not null. For example
#'
#' # assigns `a` with value `1`
#' a %<-?% 1
#'
#' # does NOT assign `a` (do nothing)
#' a %<-?% NULL
#'
#' You can remember the expression `a %?<-% b` as
#'   "`b` is null or undefined? assign to `a` if yes, otherwise nothing"
#'
dipsaus::rs_add_shortcut(8, {
  library(dipsaus)
  local({
    cts <- rstudioapi::getActiveDocumentContext()
    rstudioapi::selectionSet(" %<-?% ", cts$id)
    invisible(NULL)
  })
})


#' Insert operator `%?<-%`. This operator requires `dipsaus` to be loaded.
#' It assigns the right-hand data to the left-hand variable if the
#' left-hand variable does not exist or is `NULL`. For example
#'
#' a %?<-% 1
#'
#' assigns `a` with value `1` if `a` is undefined, or is NULL, otherwise
#' nothing will be done, and right-hand expression will not execute.
#'
#' You can remember the expression `a %?<-% b` as
#'   "`a` is null or undefined? assign `a` if yes, otherwise nothing"
#'
dipsaus::rs_add_shortcut(9, {
  library(dipsaus)
  local({
    cts <- rstudioapi::getActiveDocumentContext()
    rstudioapi::selectionSet(" %?<-% ", cts$id)
    invisible(NULL)
  })
})