1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
#' Create a slurm_job object
#'
#' This function creates a \code{slurm_job} object which can be passed to other
#' functions such as \code{\link{cancel_slurm}}, \code{\link{cleanup_files}},
#' \code{\link{get_slurm_out}} and \code{\link{get_job_status}}.
#'
#' In general, \code{slurm_job} objects are created automatically as the output of
#' \code{\link{slurm_apply}} or \code{\link{slurm_call}}, but it may be necessary
#' to manually recreate one if the job was submitted in a different R session.
#'
#' @param jobname The name of the Slurm job. The rslurm-generated scripts and
#' output files associated with a job should be found in the
#' \emph{_rslurm_[jobname]} folder.
#' @param jobid The id of the Slurm job created by the sbatch command.
#' @param nodes The number of cluster nodes used by that job.
#' @return A \code{slurm_job} object.
#' @export
slurm_job <- function(jobname = NULL, jobid = NULL, nodes = NULL) {
slr_job <- list(jobname = jobname, jobid = jobid, nodes = nodes)
class(slr_job) <- "slurm_job"
slr_job
}
|
