stopWorkflow: Abort submitted job

In shbrief/RunTerraWorkflow: Run workflows implemented in Terra/AnVIL workspace

Abort submitted job

Description

Abort submitted job

Usage

stopWorkflow(workspaceName, submissionId = NULL, dry = TRUE)

Arguments

workspaceName	Name of the workspace
submissionId	A character. Submission ID you want to abort. You can find the submission id using monitorWorkflow function. If it is not defined, the most recent submission will be aborted.
dry	Logical(1) when TRUE (default), report the consequences but do not perform the action requested. When FALSE, perform the action.

Value

This function will print out whether the call for workflow abortion was successful or not. In case it was unsuccesful, the diagnosis will be suggested as a part of the message.

Examples

library(AnVILBase)
if (
    gcloud_exists() && identical(avplatform_namespace(), "AnVILGCP") &&
    nzchar(avworkspace_name())
) {
if ("salmon" %in% avworkspaces()$name)
stopWorkflow(workspaceName = "salmon")
}

shbrief/RunTerraWorkflow documentation built on Oct. 9, 2024, noon