jobAdd: Add a Job

Description Usage Arguments Value Actions See Also

View source: R/jobs.R

Description

Inform RStudio's Jobs pane that a job has been added.

Usage

1
2
jobAdd(name, status = "", progressUnits = 0L, actions = NULL,
  running = FALSE, autoRemove = TRUE, show = TRUE)

Arguments

name

The job's name.

status

The initial status text for the job; optional.

progressUnits

The integer number of units of work in the job; for example, 100L if the job's progress is expressed in percentages. Use 0L if the number of units of work is unknown.

actions

A list of actions that can be performed on the job (see Actions).

running

Whether the job is currently running.

autoRemove

Whether to remove the job from the Jobs pane when it's complete.

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.

Actions

The actions parameter is a named list of functions that the user can invoke on the job; for example: actions = list(stop = function(id) { ... }). The function will be passed a parameter named id with the job ID that invoked it.

There are two special action names:

stop

If there is an action named stop, then the job will have a Stop button in in the Jobs pane, and pressing that button will invoke the stop action.

info

If there is an action named info, then the job will have an informational link in the Jobs pane rather than an output display, and clicking the link will invoke the info action.

See Also

Other jobs: jobAddOutput, jobAddProgress, jobRemove, jobRunScript, jobSetProgress, jobSetState, jobSetStatus


rstudio/rstudioapi documentation built on Feb. 16, 2019, 5:42 a.m.