galaxy_get_tool_id: Retrieve Galaxy tool IDs by name

View source: R/2025-10-27_JF_R_Galaxy_functions.R

galaxy_get_tool_idR Documentation

Retrieve Galaxy tool IDs by name

Description

Retrieve Galaxy tool IDs by name

Usage

galaxy_get_tool_id(
  name,
  tools = NULL,
  ignore_case = TRUE,
  galaxy_url = "https://usegalaxy.eu",
  panel_id = NULL
)

Arguments

name

Character string to search for in tool names.

tools

Optional list as returned by galaxy_list_tools. If NULL, the function will fetch tools on the fly by calling galaxy_list_tools.

ignore_case

Logical. Whether matching should ignore case. Default: TRUE.

galaxy_url

Character. Base URL of the Galaxy instance (for example "https://usegalaxy.eu"). If the environment variable GALAXY_URL is set, it takes precedence.

panel_id

Optional character. Passed through to galaxy_list_tools when tools is NULL so you can restrict the search to a panel/section.

Value

Character vector of matching tool IDs in decreasing order (usually highest version first). Returns character(0) if no tools match.

Examples


# Fetch the full tool list once, then lookup
tools <- galaxy_list_tools()
galaxy_get_tool_id("FastQC", tools = tools)

# Or let the helper fetch on demand
galaxy_get_tool_id("FastQC")

# Exact, case-sensitive match inside a specific panel
galaxy_get_tool_id("Concatenate datasets",
ignore_case = FALSE, panel_id = "Text Manipulation")


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