File: cfHandleUnknownSubmitError.Rd

package info (click to toggle)
r-cran-batchtools 0.9.15%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,416 kB
  • sloc: ansic: 172; sh: 156; makefile: 2
file content (38 lines) | stat: -rw-r--r-- 1,251 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/clusterFunctions.R
\name{cfHandleUnknownSubmitError}
\alias{cfHandleUnknownSubmitError}
\title{Cluster Functions Helper to Handle Unknown Errors}
\usage{
cfHandleUnknownSubmitError(cmd, exit.code, output)
}
\arguments{
\item{cmd}{[\code{character(1)}]\cr
OS command used to submit the job, e.g. qsub.}

\item{exit.code}{[\code{integer(1)}]\cr
Exit code of the OS command, should not be 0.}

\item{output}{[\code{character}]\cr
Output of the OS command, hopefully an informative error message.
If these are multiple lines in a vector, they are automatically joined.}
}
\value{
[\code{\link{SubmitJobResult}}].
}
\description{
This function is only intended for use in your own cluster functions implementation.

Simply constructs a \code{\link{SubmitJobResult}} object with status code 101, NA as batch id and
an informative error message containing the output of the OS command in \code{output}.
}
\seealso{
Other ClusterFunctionsHelper: 
\code{\link{cfBrewTemplate}()},
\code{\link{cfKillJob}()},
\code{\link{cfReadBrewTemplate}()},
\code{\link{makeClusterFunctions}()},
\code{\link{makeSubmitJobResult}()},
\code{\link{runOSCommand}()}
}
\concept{ClusterFunctionsHelper}