Learn R Programming

batchtools (version 0.9.0)

cfKillJob: Cluster Functions Helper to Kill Batch Jobs

Description

This function is only intended for use in your own cluster functions implementation.

Calls the OS command to kill a job via system like this: “cmd batch.job.id”. If the command returns an exit code > 0, the command is repeated after a 1 second sleep max.tries-1 times. If the command failed in all tries, an exception is generated.

Usage

cfKillJob(reg, cmd, args = character(0L), max.tries = 3L)

Arguments

reg
[Registry] Registry. If not explicitly passed, uses the default registry (see setDefaultRegistry).
cmd
[character(1)] OS command, e.g. “qdel”.
args
[character] Arguments to cmd, including the batch id.
max.tries
[integer(1)] Number of total times to try execute the OS command in cases of failures. Default is 3.

Value

TRUE on success. An exception is raised otherwise.

See Also

Other ClusterFunctionsHelper: cfBrewTemplate, cfHandleUnknownSubmitError, cfReadBrewTemplate, makeClusterFunctions, makeSubmitJobResult, runOSCommand