File: cancel_slurm.Rd

package info (click to toggle)
r-cran-rslurm 0.6.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 428 kB
  • sloc: sh: 25; makefile: 5
file content (21 lines) | stat: -rwxr-xr-x 597 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cancel_cleanup.R
\name{cancel_slurm}
\alias{cancel_slurm}
\title{Cancels a scheduled Slurm job}
\usage{
cancel_slurm(slr_job)
}
\arguments{
\item{slr_job}{A \code{slurm_job} object.}
}
\description{
This function cancels the specified Slurm job by invoking the Slurm 
\code{scancel} command. It does \emph{not} delete the temporary files 
(e.g. scripts) created by \code{\link{slurm_apply}} or 
\code{\link{slurm_call}}. Use \code{\link{cleanup_files}} to remove those 
files.
}
\seealso{
\code{\link{cleanup_files}}
}