wbt_tool_help: Help description for a specific tool in 'WhiteboxTools'

View source: R/wbt.R

wbt_tool_helpR Documentation

Help description for a specific tool in 'WhiteboxTools'

Description

Retrieves the help description for a specific tool.

Usage

wbt_tool_help(tool_name = NULL)

Arguments

tool_name

The name of the tool.

Details

Leaving tool_name as default NULL returns results for all tools, but does not work on Windows.

Value

Returns the help description for a specific tool.

Examples

## Not run: 
wbt_tool_help("lidar_info")

## End(Not run)

whitebox documentation built on Nov. 19, 2023, 1:07 a.m.