galaxy_poll_workflow: Generic for polling workflows

In GalaxyR: 'Galaxy' API Implementation

Generic for polling workflows

Description

galaxy_poll_workflow() is an S4 generic. With x as a character vector it is treated as a workflow invocation ID; the invocation is polled until it completes and a list of output dataset IDs is returned. With x as a Galaxy object, the invocation_id and galaxy_url are taken from the object, and the object is updated with the resulting output_dataset_ids and state.

Usage

galaxy_poll_workflow(
  x,
  galaxy_url = "https://usegalaxy.eu",
  poll_interval = 30,
  ...
)

## S4 method for signature 'character'
galaxy_poll_workflow(
  x,
  galaxy_url = "https://usegalaxy.eu",
  poll_interval = 30,
  ...
)

## S4 method for signature 'Galaxy'
galaxy_poll_workflow(
  x,
  galaxy_url = "https://usegalaxy.eu",
  poll_interval = 30,
  ...
)

Arguments

x	A workflow invocation ID (character) or a Galaxy object.
galaxy_url	Base URL of the Galaxy instance, used by the character method. If GALAXY_URL is set it takes precedence.
poll_interval	Time in seconds between polling attempts.
...	not in use

Value

For the character method, a list with elements success and output_ids. For the Galaxy method, the modified Galaxy object.

Examples

invocation_id <- "abc123"
galaxy_poll_workflow(invocation_id)

GalaxyR documentation built on July 6, 2026, 5:08 p.m.