show_galaxy_header: show_galaxy_header - shows the header for glaxy tools
In W4MRUtils: Utils List for W4M - Workflow for Metabolomics

show_galaxy_header

R Documentation

show_galaxy_header - shows the header for glaxy tools

Description

This function prints the header to display in galaxy's tools logs

Usage

show_galaxy_header(
  tool_name,
  tool_version,
  args = NULL,
  logger = NULL,
  show_start_time = TRUE,
  show_sys = TRUE,
  show_parameters = TRUE
)

Arguments

`tool_name`	a `character(1)` holding the running tool's name.
`tool_version`	a `character(1)` holding the running tool's version.
`args`	a `list(param="value")` - if provided, their are the parameters shown in galaxy header and/or footer.
`logger`	a `get_logger("name")` instance - if provided, the galaxy footer if output from the logger.
`show_start_time`	a logical telling whether to display the start time or not.
`show_sys`	a logical telling whether to display the system variables or not.
`show_parameters`	a logical telling whether to display the parameters or not.

Author(s)

L.Pavot

Examples


show_galaxy_header("Tool Name", "1.2.0")
show_galaxy_header(
  tool_name = "Tool Name",
  tool_version = "1.2.0",
  logger = get_logger("Some Tool"),
  show_start_time = FALSE,
  show_sys = FALSE,
  show_parameters = FALSE
)

W4MRUtils documentation built on Sept. 8, 2023, 5:11 p.m.