runWorkflow: Launch Terra workflow

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

Launch Terra workflow

Description

Launch Terra workflow

Usage

runWorkflow(
  workspaceName,
  config,
  workflowName = NULL,
  useCallCache = TRUE,
  inputName = NULL
)

Arguments

workspaceName	Name of the workspace that contains the workflow(s) you want to launch.
config	Workflow configuration. Output from the getWorkflowConfig function.
workflowName	Name of the workflow to run. If this input is not provided but there is only a single workflow available, the function will automatically use the only workflow.
useCallCache	A logical. Under the default condition (TRUE), call cache will be used.
inputName	Name of you input entity. If the workflow is using Terra's data model, this is required. The available entities can be found using the findInputName function.

Value

This function will print out whether the call for workflow launching was successful or not.

Examples

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

shbrief/RunTerraWorkflow documentation built on Oct. 31, 2024, 1:22 p.m.