galaxy_initialize: Create a new Galaxy history

In GalaxyR: 'Galaxy' API Implementation

Create a new Galaxy history

Description

galaxy_initialize() is an S4 generic. With no x supplied it creates a new history on the given Galaxy instance and returns its encoded ID. When called with a Galaxy object it uses the object’s history_name and galaxy_url, creates the history, and updates the object with the new history_id and state "pending".

Usage

galaxy_initialize(
  x,
  name = "R API request",
  galaxy_url = "https://usegalaxy.eu"
)

## S4 method for signature 'missing'
galaxy_initialize(name, galaxy_url)

## S4 method for signature 'Galaxy'
galaxy_initialize(x)

Arguments

x	A Galaxy object, or missing to use the default method.
name	Name of the history to create. Ignored when x is a Galaxy, in which case x@history_name is used.
galaxy_url	Base URL of the Galaxy instance. Ignored when x is a Galaxy, in which case x@galaxy_url is used.

Details

A valid Galaxy API key is required and must be available via the GALAXY_API_KEY environment variable.

Value

For the default method (x missing), a character scalar history ID. For the Galaxy method, the modified Galaxy object.

Examples

history_id <- galaxy_initialize("My history name")
g <- galaxy(history_name = "My history name")
g <- galaxy_initialize(g)

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