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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/jobs.R
\name{jobAdd}
\alias{jobAdd}
\title{Add a Job}
\usage{
jobAdd(
name,
status = "",
progressUnits = 0L,
actions = NULL,
running = FALSE,
autoRemove = TRUE,
show = TRUE
)
}
\arguments{
\item{name}{The background job's name.}
\item{status}{The initial status text for the job; optional.}
\item{progressUnits}{The integer number of units of work in the job; for
example, \code{100L} if the job's progress is expressed in percentages. Use
\code{0L} if the number of units of work is unknown.}
\item{actions}{A list of actions that can be performed on the job (see
Actions).}
\item{running}{Whether the job is currently running.}
\item{autoRemove}{Whether to remove the job from the Background Jobs pane
when it's complete.}
\item{show}{Whether to show the job in the Jobs pane.}
}
\value{
An ID representing the newly added job, used as a handle to provide
further updates of the job's status.
}
\description{
Inform RStudio's Background Jobs pane that a job has been added.
}
\section{Actions}{
The \code{actions} parameter is a named list of functions that the user can
invoke on the job; for example: \code{actions = list(stop = function(id) {
... })}. The function will be passed a parameter named \code{id} with the
job ID that invoked it.
There are three special action names: \describe{ \item{stop}{If there is an
action named \code{stop}, then the job will have a Stop button in in the
Jobs pane, and pressing that button will invoke the \code{stop} action.}
\item{info}{If there is an action named \code{info}, then the job will have
an informational link in the Background Jobs pane rather than an output display,
and clicking the link will invoke the \code{info} action.}
\item{replay}{If there is an action named \code{replay}, then the job will
have a Replay button that displays when the job has finished running. Clicking
the button will invoke the \code{replay} action.}}
}
\seealso{
Other jobs:
\code{\link{jobAddOutput}()},
\code{\link{jobAddProgress}()},
\code{\link{jobGetState}()},
\code{\link{jobList}()},
\code{\link{jobRemove}()},
\code{\link{jobRunScript}()},
\code{\link{jobSetProgress}()},
\code{\link{jobSetState}()},
\code{\link{jobSetStatus}()}
}
\concept{jobs}
|
