Package: slurmR 0.5-4

George Vega Yon

slurmR: A Lightweight Wrapper for 'Slurm'

'Slurm', Simple Linux Utility for Resource Management <https://slurm.schedmd.com/>, is a popular 'Linux' based software used to schedule jobs in 'HPC' (High Performance Computing) clusters. This R package provides a specialized lightweight wrapper of 'Slurm' with a syntax similar to that found in the 'parallel' R package. The package also includes a method for creating socket cluster objects spanning multiple nodes that can be used with the 'parallel' package.

Authors:George Vega Yon [aut, cre], Paul Marjoram [ctb, ths], National Cancer Institute [fnd], Michael Schubert [rev], Michel Lang [rev]

slurmR_0.5-4.tar.gz
slurmR_0.5-4.zip(r-4.5)slurmR_0.5-4.zip(r-4.4)slurmR_0.5-4.zip(r-4.3)
slurmR_0.5-4.tgz(r-4.4-any)slurmR_0.5-4.tgz(r-4.3-any)
slurmR_0.5-4.tar.gz(r-4.5-noble)slurmR_0.5-4.tar.gz(r-4.4-noble)
slurmR_0.5-4.tgz(r-4.4-emscripten)slurmR_0.5-4.tgz(r-4.3-emscripten)
slurmR.pdf |slurmR.html
slurmR/json (API)
NEWS

# Install 'slurmR' in R:
install.packages('slurmR', repos = c('https://uscbiostats.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/uscbiostats/slurmr/issues

On CRAN:

bioinformaticshpcslurm

8.03 score 58 stars 1 packages 203 scripts 304 downloads 41 exports 0 dependencies

Last updated 1 years agofrom:df891c49cb. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 05 2024
R-4.5-winOKNov 05 2024
R-4.5-linuxOKNov 05 2024
R-4.4-winOKNov 05 2024
R-4.4-macOKNov 05 2024
R-4.3-winOKNov 05 2024
R-4.3-macOKNov 05 2024

Exports:docker_availableexpand_array_indexesJOB_STATE_CODESlast_joblast_submitted_jobmakeSlurmClusternew_rscriptnew_slurm_jobopts_slurmRparse_flagsrandom_job_nameread_sbatchread_slurm_jobsacctsacct_sbatchscancelSchedulerParametersslurm_availableSlurm_cleanSlurm_collectSlurm_envSlurm_EvalQSlurm_lapplySlurm_logSlurm_MapSlurm_sapplyslurm.confslurmr_cmdslurmr_docker_pullslurmr_docker_runslurmr_docker_stopsnamessourceSlurmsqueuestatusthe_planwait_slurmwhoamiWhoAmIwrite_slurm_job

Dependencies:

Getting Started with slurmR

Rendered fromgetting-started.Rmdusingknitr::rmarkdownon Nov 05 2024.

Last update: 2023-10-25
Started: 2018-09-20

Re-submission and debugging

Rendered fromdebugging-re-submission.Rmdusingknitr::rmarkdownon Nov 05 2024.

Last update: 2021-01-25
Started: 2020-02-14

Working with Slurm

Rendered fromworking-with-slurm.Rmdusingknitr::rmarkdownon Nov 05 2024.

Last update: 2021-09-02
Started: 2019-12-17

Readme and manuals

Help Manual

Help pageTopics
Expand Array Indexesexpand_array_indexes
Slurm Job state codesJOB_STATE_CODES
Create a Parallel Socket Cluster using SlurmmakeSlurmCluster stopCluster.slurm_cluster
General purpose function to write R scriptsnew_rscript
Get and set default options for 'sbatch' and 'slurmR' internalsopts_slurmR
Utility functionparse_flags parse_flags.default parse_flags.list
Generate a random job namerandom_job_name
Read a slurm batch file and capture the SBATCH optionsread_sbatch
R wrappers for _Slurm_ commandssacct sacct.default sacct.slurm_job sacct_ sbatch sbatch.character sbatch.slurm_job scancel scancel.default scancel.slurm_job SchedulerParameters slurm.conf slurm_available squeue squeue.default squeue.slurm_job submit
Clean a session.Slurm_clean
Collect the results of a slurm jobSlurm_collect Slurm_collect.slurm_job
A wrapper of Sys.getenvSlurm_env
Submit an expression to be evaluated to multiple jobs.Slurm_EvalQ
Creating Slurm jobslast_job last_submitted_job new_slurm_job print.slurm_job read_slurm_job slurm_job write_slurm_job
Check the R logfile of a job.Slurm_log
The Slurm version of the '*apply' family of functions.Slurm_lapply Slurm_Map Slurm_sapply
A Lightweight Wrapper for 'Slurm'slurmR-package slurmR
slurmR docker imagedocker_available slurmr_docker slurmr_docker_pull slurmr_docker_run slurmr_docker_stop
Full path names for Slurm jobssnames
Source an R script as a Slurm jobslurmr_cmd sourceSlurm
Check the status of a Slurm JOB$.slurm_status status status.default status.slurm_job
Check for possible actions for a 'slurm_job' wrapperthe_plan
Wait for a Slurm job to be completedwait_slurm wait_slurm.integer wait_slurm.slurm_job
Information about where jobs are submittedWhoAmI whoami