jobSetState: Set Background Job State
In rstudioapi: Safely Access the RStudio API
jobSetState R Documentation
Set Background Job State
Description
Changes the state of a background job.
Usage
jobSetState(
job,
state = c("idle", "running", "succeeded", "cancelled", "failed")
)
Arguments
job
The ID of the job on which to change state.
state
The new job state.
States
The following states are supported:
- idle
The job is
waiting to run.
- running
The job is actively running.
- succeeded
The job has finished successfully.
- cancelled
The
job was cancelled.
- failed
The job finished but did not succeed.
See Also
Other jobs:
jobAdd(),
jobAddOutput(),
jobAddProgress(),
jobGetState(),
jobList(),
jobRemove(),
jobRunScript(),
jobSetProgress(),
jobSetStatus()
rstudioapi documentation built on Oct. 23, 2024, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| jobSetState | R Documentation |
Set Background Job State
Description
Changes the state of a background job.
Usage
jobSetState(
job,
state = c("idle", "running", "succeeded", "cancelled", "failed")
)
Arguments
job |
The ID of the job on which to change state. |
state |
The new job state. |
States
The following states are supported:
- idle
The job is waiting to run.
- running
The job is actively running.
- succeeded
The job has finished successfully.
- cancelled
The job was cancelled.
- failed
The job finished but did not succeed.
See Also
Other jobs:
jobAdd(),
jobAddOutput(),
jobAddProgress(),
jobGetState(),
jobList(),
jobRemove(),
jobRunScript(),
jobSetProgress(),
jobSetStatus()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.