Get Help for Tool or Command — sn_help • ShennongTools

Displays help information for a tool or specific command. This function automatically manages the toolbox and can be called directly with tool name.

Usage

sn_help(tool_name, command = NULL, version = NULL, raw = FALSE)

Arguments

tool_name: Character. Name of the tool.
command: Character. Specific command (optional).
version: Character. Tool version (optional).
raw: Logical. If TRUE, shows raw tool help output using the tool's help flag. If FALSE (default), shows formatted help from YAML configuration.

Value

Invisible. Help information is printed to console.

See also

Other tool information: sn_get_tool_config(), sn_get_tool_info(), sn_help_builtin(), sn_list_tools(), sn_load_registry(), sn_show_tool()

Examples

if (FALSE) { # \dontrun{
# Get help for tool
sn_help("samtools")

# Get help for specific command
sn_help("samtools", "view")

# Get raw tool help output
sn_help("samtools", raw = TRUE)
} # }