slurmr_docker: slurmR docker image

In slurmR: A Lightweight Wrapper for 'Slurm'

slurmR docker image

Description

Helper functions to use slurmR's docker image. This requires having an internet connection and docker installed in your system.

Usage

docker_available(path = "")

slurmr_docker_pull(path = "")

slurmr_docker_run(path = "", pull = TRUE, timeout = 60)

slurmr_docker_stop(UUID = "", path = "")

Arguments

path	Path to the docker executable. If not specified, the function will try to figure it out by itself.
pull	Logical scalar. When TRUE, if not available, it will invoke ⁠docker pull⁠.
timeout	Integer. Number of seconds to wait for docker to start the slurmR image.
UUID	String. Universally Unique Identifier.

Details

Starting version 0.5-0, a Docker image with Slurm, R, and slurmR is available at https://hub.docker.com/r/uscbiostats/slurmr. The source code (Dockerfile) is available in the project GitHub repository: https://github.com/USCbiostats/slurmR.

Examples

# This example requires having Docker installed in the system
## Not run: 
  # Start the docker image. By default it will try to pull the
  # image from Docker Hub if available

  # This opens a bash session with R + Slurm + slurmR
  slurmr_docker_run() 

  # Will pull the docker image
  slurmr_docker_pull()



## End(Not run)

slurmR documentation built on Aug. 30, 2023, 5:06 p.m.