Skip to content

Latest commit

 

History

History
197 lines (152 loc) · 7.78 KB

README.md

File metadata and controls

197 lines (152 loc) · 7.78 KB
Raw

ClusterMQ: send R function calls as cluster jobs

CRAN version Build Status CRAN downloads DOI

This package will allow you to send function calls as jobs on a computing cluster with a minimal interface provided by the Q function:

# load the library and create a simple function
library(clustermq)
fx = function(x) x * 2

# queue the function call on your scheduler
Q(fx, x=1:3, n_jobs=1)
# list(2,4,6)

Computations are done entirely on the network and without any temporary files on network-mounted storage, so there is no strain on the file system apart from starting up R once per job. All calculations are load-balanced, i.e. workers that get their jobs done faster will also receive more function calls to work on. This is especially useful if not all calls return after the same time, or one worker has a high load.

Browse the vignettes here:

Installation

Install the clustermq package in R from CRAN (including the bundled ZeroMQ system library):

install.packages('clustermq')

Alternatively you can use the remotes package to install directly from Github. Note that this version needs autoconf/automake and CMake for compilation:

# install.packages('remotes')
remotes::install_github('mschubert/clustermq')
# remotes::install_github('mschubert/clustermq@develop') # dev version

Tip

For installation problems, see the FAQ

Schedulers

An HPC cluster's scheduler ensures that computing jobs are distributed to available worker nodes. Hence, this is what clustermq interfaces with in order to do computations.

We currently support the following schedulers (either locally or via SSH):

  • Multiprocess - test your calls and parallelize on cores using options(clustermq.scheduler="multiprocess")
  • SLURM - should work without setup
  • LSF - should work without setup
  • SGE - may require configuration
  • PBS/Torque - needs options(clustermq.scheduler="PBS"/"Torque")
  • via SSH - needs options(clustermq.scheduler="ssh", clustermq.ssh.host=<yourhost>)

Tip

Follow the links above to configure your scheduler in case it is not working out of the box and check the FAQ if your job submission errors or gets stuck

Usage

The most common arguments for Q are:

  • fun - The function to call. This needs to be self-sufficient (because it will not have access to the master environment)
  • ... - All iterated arguments passed to the function. If there is more than one, all of them need to be named
  • const - A named list of non-iterated arguments passed to fun
  • export - A named list of objects to export to the worker environment

The documentation for other arguments can be accessed by typing ?Q. Examples of using const and export would be:

# adding a constant argument
fx = function(x, y) x * 2 + y
Q(fx, x=1:3, const=list(y=10), n_jobs=1)
# exporting an object to workers
fx = function(x) x * 2 + y
Q(fx, x=1:3, export=list(y=10), n_jobs=1)

clustermq can also be used as a parallel backend for foreach. As this is also used by BiocParallel, we can run those packages on the cluster as well:

library(foreach)
register_dopar_cmq(n_jobs=2, memory=1024) # see `?workers` for arguments
foreach(i=1:3) %dopar% sqrt(i) # this will be executed as jobs
library(BiocParallel)
register(DoparParam()) # after register_dopar_cmq(...)
bplapply(1:3, sqrt)

More examples are available in the User Guide.

Comparison to other packages

There are some packages that provide high-level parallelization of R function calls on a computing cluster. We compared clustermq to BatchJobs and batchtools for processing many short-running jobs, and found it to have approximately 1000x less overhead cost.

Overhead comparison

In short, use clustermq if you want:

  • a one-line solution to run cluster jobs with minimal setup
  • access cluster functions from your local Rstudio via SSH
  • fast processing of many function calls without network storage I/O

Use batchtools if you:

  • want to use a mature and well-tested package
  • don't mind that arguments to every call are written to/read from disc
  • don't mind there's no load-balancing at run-time

Use Snakemake or targets if:

  • you want to design and run a workflow on HPC

Don't use batch (last updated 2013) or BatchJobs (issues with SQLite on network-mounted storage).

Contributing

Contributions are welcome and they come in many different forms, shapes, and sizes. These include, but are not limited to:

  • Questions: Ask on the Github Discussions board. If you are an advanced user, please also consider answering questions there.
  • Bug reports: File an issue if something does not work as expected. Be sure to include a self-contained Minimal Reproducible Example and set log_worker=TRUE.
  • Code contributions: Have a look at the good first issue tag. Please discuss anything more complicated before putting a lot of work in, I'm happy to help you get started.

Tip

Check the User Guide and the FAQ first, maybe your query is already answered there

Citation

This project is part of my academic work, for which I will be evaluated on citations. If you like me to be able to continue working on research support tools like clustermq, please cite the article when using it for publications:

M Schubert. clustermq enables efficient parallelisation of genomic analyses. Bioinformatics (2019). doi:10.1093/bioinformatics/btz284