galaxy_list_tools: List tools installed on a Galaxy instance

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

galaxy_list_toolsR Documentation

List tools installed on a Galaxy instance

Description

List tools installed on a Galaxy instance

Usage

galaxy_list_tools(
  galaxy_url = "https://usegalaxy.eu",
  in_panel = FALSE,
  panel_id = NULL
)

Arguments

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.

in_panel

Logical. If TRUE, return the tool panel structure (sections/categories). If FALSE, return the flat list of all tools as supplied by Galaxy. Default: FALSE.

panel_id

Optional character. When supplied, only tools from the matching panel (section/category) are returned. The value is matched against both the panel id and name. Supplying panel_id automatically requests the panelized structure, regardless of the value of in_panel.

Value

A list corresponding to the parsed JSON returned by Galaxy. If panel_id is provided, a list of tool entries belonging to the requested panel is returned (each entry is the raw tool metadata as provided by Galaxy).

Examples


# All tools (flat list)
tools_list <- galaxy_list_tools()
length(tools_list)

# Panel structure
panel_list <- galaxy_list_tools(in_panel = TRUE)
length(panel_list)

# Tools from a specific panel (match by id or name)
tools_list <- galaxy_list_tools(panel_id = "Get Data")
length(tools_list)


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