README.md

In metrumresearchgroup/rrsq: R interface to r simple queue (rsq)

RRSQ

A simple interface for interacting with an R Simple Queue using R.

Getting Started

Note: This guide assumes you already have an RSQ instance running locally on your computer.

Simply install the package and create an RSimpleQueue object to get rolling.

devtools::install_github("https://github.com/metrumresearchgroup/rrsq")

queue <- RSimpleQueue$new()

From here, you can use several functions to interact with the queue.

## Submits a job to be run on the queue.
jobject1 <- queue$submit_job(
  user = "Dreznel",
  context = "Some job context",
  work_dir = getwd(),
  rscript_path = system.file("inst/qview/long_sample.R", package = "rrsq")
)

## Retrieves a single job with the given ID from the queue.
queue$get_job(jobject1$id)

## Retrieves all jobs from the queue. Combine with rrsq::jobs_to_df(queue$get_jobs()) to get a dataframe of the jobs.
queue$get_jobs()

## Cancels the job with the given ID, assuming its status is "QUEUED" when the request is sent.
queue$cancel_job(jobject1$id) 

Additionally, RRSQ includes a Shiny module to easily create a viewable list of each job in the queue for the current user.

ui <- shiny::fluidPage(

  ## Will display a searchable table of jobs on the queue for the current user.
  rrsq::queueViewOutput("any_id_you_want"),

  ## Will display the row currently highlighted in the table.
  tableOutput("row")
)

server <- function(input, output, session) {

  ## Customizable buttons can optionally be added to the table.
  button_ids = c("X_button", "A_button", "B_button", "C_button")
  button_labels = c("X", "A", "B", "C")

  module_return_reactive_values <- shiny::callModule(
    rrsq::queueView,
    "any_id_you_want",
    queue_obj = rrsq::RSimpleQueue$new(),
    button_ids = button_ids,
    button_labels = button_labels,
    .user = rrsq::whoami(session = session, .mock_user = "Sheersa"),
    .refresh_interval = 3000
  )

  ## Highlighted row can be acccessed via the return value of the module.
  ## Currently, only one row can be highlighted at a time.
  output$row <- shiny::renderTable(module_return_reactive_values$highlighted_rows)

  ## Buttons added to the table can be observed by the IDs you have assigned them.
  ## The input value of the button will be assigned to the index of the row it was
  ## clicked from.
  observeEvent(input$X_button, {
    x_job_id <- dplyr::slice(module_return_reactive_values$rows, as.numeric(input$X_button))
    showNotification(glue::glue("X Clicked for job id {x_job_id}!"))
    print(dplyr::slice(module_return_reactive_values$rows, as.numeric(input$X_button)))
  })

  observeEvent(input$A_button, {
    a_index <- input$A_button
    showNotification(glue::glue("A Clicked for row {a_index}"))
  })
}

shiny::shinyApp(ui = ui, server = server)

JSON can be used as an interchange format

library(rrsq)
jsonlite::toJSON(unbox_details(collect_r_details()), pretty =TRUE)

## {
##   "r_path": "/Library/Frameworks/R.framework/Resources/bin/R",
##   "renv": {
##     "R_ARCH": "",
##     "R_BROWSER": "/usr/bin/open",
##     "R_BZIPCMD": "/usr/bin/bzip2",
##     "R_DOC_DIR": "/Library/Frameworks/R.framework/Resources/doc",
##     "R_GZIPCMD": "/usr/bin/gzip",
##     "R_HOME": "/Library/Frameworks/R.framework/Resources",
##     "R_INCLUDE_DIR": "/Library/Frameworks/R.framework/Resources/include",
##     "R_LIBS": "/Library/Frameworks/R.framework/Versions/3.5/Resources/library",
##     "R_LIBS_SITE": "",
##     "R_LIBS_USER": "~/Library/R/3.5/library",
##     "R_PAPERSIZE": "a4",
##     "R_PAPERSIZE_USER": "a4",
##     "R_PDFVIEWER": "/usr/bin/open",
##     "R_PLATFORM": "x86_64-apple-darwin15.6.0",
##     "R_PRINTCMD": "lpr",
##     "R_QPDF": "/Library/Frameworks/R.framework/Resources/bin/qpdf",
##     "R_RD4PDF": "times,inconsolata,hyper",
##     "R_SESSION_TMPDIR": "/var/folders/kn/ny6x14mj6sj97c050mp06ywc0000gn/T//Rtmpf4pKMx",
##     "R_SHARE_DIR": "/Library/Frameworks/R.framework/Resources/share",
##     "R_SYSTEM_ABI": "osx,gcc,gxx,gfortran,?",
##     "R_TEXI2DVICMD": "/usr/local/bin/texi2dvi",
##     "R_UNZIPCMD": "/usr/bin/unzip",
##     "R_ZIPCMD": "/usr/bin/zip"
##   },
##   "work_dir": "/Users/johncarlos/openspace/rrsq"
## }

metrumresearchgroup/rrsq documentation built on Aug. 20, 2021, 3:20 p.m.