galaxy_start_workflow: Generic start workflow
In GalaxyR: 'Galaxy' API Implementation

galaxy_start_workflow

R Documentation

Generic start workflow

Description

galaxy_start_workflow() is an S4 generic. With x as a character vector it is treated as a history ID: the given workflow is invoked in that history and the invocation ID is returned. With x as a Galaxy object, the history ID and URL are taken from the object; the workflow is started and the object is updated with the resulting invocation_id.

Usage

galaxy_start_workflow(
  x,
  workflow_id,
  inputs = NULL,
  dataset_id = NULL,
  galaxy_url = "https://usegalaxy.eu"
)

## S4 method for signature 'character'
galaxy_start_workflow(
  x,
  workflow_id,
  inputs = NULL,
  dataset_id = NULL,
  galaxy_url = "https://usegalaxy.eu"
)

## S4 method for signature 'Galaxy'
galaxy_start_workflow(x, workflow_id, inputs = NULL, dataset_id = NULL)

Arguments

`x`	A `Galaxy` object, or a history ID (`character`) to use the default method.
`workflow_id`	Character. Galaxy workflow ID.
`inputs`	Named list. Optional workflow input mapping; keys are workflow input step IDs, values are lists describing datasets/parameters.
`dataset_id`	Character. ID of the input dataset (HDA). Ignored if `inputs` is supplied. When `x` is a `Galaxy` and `dataset_id` is missing, `x@input_dataset_id` is used.
`galaxy_url`	Base URL of the Galaxy instance, used by the character method. If `GALAXY_URL` is set it takes precedence.