rs_delete: Delete AppEEARS task from queue

View source: R/rs_delete.R

rs_deleteR Documentation

Delete AppEEARS task from queue

Description

Removes a task from the queue and or buffer

Usage

rs_delete(task_id, user, purge = FALSE)

Arguments

task_id

AppEEARS task id

user

username used to sign up

purge

if TRUE, remove all previously finished tasks from the task list (default = FALSE)

Value

returns the content of the API call

Author(s)

Koen Hufkens

Examples


## Not run: 
# delete a single task
rs_delete(
  user = "your_user_name",
  task_id = "a_task_id"
)

# delete all finished or crashed
# jobs (if not deleted previously)
rs_delete(
  user = "your_user_name",
  purge = TRUE
)

## End(Not run)

appeears documentation built on Sept. 15, 2023, 5:06 p.m.