slurm_job {rslurm}

Create a slurm_job object

Description

This function creates a slurm_job object which can be passed to other functions such as cancel_slurm, cleanup_files, get_slurm_out and get_job_status.

Usage

slurm_job(jobname = NULL, jobid = NULL, nodes = NULL)

Arguments

jobname

The name of the Slurm job. The rslurm-generated scripts and output files associated with a job should be found in the _rslurm_[jobname] folder.

jobid

The id of the Slurm job created by the sbatch command.

nodes

The number of cluster nodes used by that job.

Details

In general, slurm_job objects are created automatically as the output of slurm_apply or slurm_call, but it may be necessary to manually recreate one if the job was submitted in a different R session.

Value

A slurm_job object.