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 error is generated.

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

## Arguments

reg [Registry] Registry. If not explicitly passed, uses the default registry (see setDefaultRegistry). [character(1)] OS command, e.g. “qdel”. [character] Arguments to cmd, including the batch id. [integer(1)] Number of total times to try execute the OS command in cases of failures. Default is 3. [character(1)] Name of the SSH node to run the command on. If set to “localhost” (default), the command is not piped through SSH.

## Value

TRUE on success. An exception is raised otherwise.

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