jokergoo / bsub

Send R code/R scripts/shell commands to LSF cluster without leaving R

Home Page:https://jokergoo.github.io/bsub

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Submitter and Monitor of the LSF Cluster

R-CMD-check CRAN

It sends R code/R scripts/shell commands to LSF cluster without leaving R.

Install

if (!requireNamespace("devtools", quietly = TRUE))
    install.packages("devtools")
devtools::install_github("jokergoo/bsub")

If you want the full functionality of the package, you need to install a few more packages:

devtools::install_github('jokergoo/bsub', dependencies = 'Suggests')

Documentation

The online documentation is available at https://jokergoo.github.io/bsub/.

There are the following vignettes:

Submit jobs

Directly submit R chunk:

library(bsub)

# R code
bsub_chunk(name = "example", memory = 10, hours = 10, cores = 4, 
{
    fit = NMF::nmf(...)
    # you better save `fit` into a permanent file
    saveRDS(fit, file = "/path/of/fit.rds")
})

Submit an R script:

# R script
bsub_script(name = "example",
    script = "/path/of/foo.R", ...)

Submit shell commands:

# shell commands
bsub_cmd(name = "example",
    cmd = "samtools view ...", ...)

Kill jobs:

bkill(job_id)

View job info

View job summaries:

bjobs
brecent
bjobs_running
bjobs_pending
bjobs_done
bjobs_exit

An example of the job queries is as follows:

image

View job log:

job_log(job_id)

Interactive job monitor

monitor()

The job summary table:

monitor

Job log:

job_log

Job dependency diagram:

dependency_graph

License

MIT @ Zuguang Gu

About

Send R code/R scripts/shell commands to LSF cluster without leaving R

https://jokergoo.github.io/bsub

License:Other


Languages

Language:R 94.5%Language:JavaScript 4.2%Language:CSS 1.3%