galaxy_set_credentials: Set Galaxy connection parameters for the current R session

In GalaxyR: 'Galaxy' API Implementation

Set Galaxy connection parameters for the current R session

Description

Set Galaxy connection parameters for the current R session

Usage

galaxy_set_credentials(
  api_key = NULL,
  username = NULL,
  password = NULL,
  galaxy_url = "https://usegalaxy.eu",
  overwrite = TRUE
)

Arguments

api_key	Character. Galaxy API key.
username	Character. Galaxy username (only required for FTP uploads).
password	Character. Galaxy password (only required for FTP uploads).
galaxy_url	Character. Base URL of the Galaxy instance (e.g. "https://usegalaxy.eu"). If set all galaxy_url arguments of functions will be ignored.
overwrite	Logical. Whether to overwrite existing environment variables. Default: TRUE.

Details

This helper is intended for interactive sessions. It sets the following environment variables using Sys.setenv():

• GALAXY_API_KEY

• GALAXY_URL

• GALAXY_USERNAME

• GALAXY_PASSWORD

Only arguments that are provided (non-NULL) are set.

Value

Invisibly returns a named list of values that were set.

Examples

# This requires valid credentials to your galaxy instance
## Not run: 
galaxy_set_credentials(
  api_key = "your-secret-key",
  username = "your-username",
  password = "your-password",
  galaxy_url = "https://usegalaxy.eu"
)

## End(Not run)

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