whitebox examples

In whitebox: 'WhiteboxTools' R Frontend

About WhiteboxTools

Load the whitebox R package.

library(whitebox)

Prints the whitebox-tools help...a listing of available commands.

print(wbt_help())

Prints the whitebox-tools license.

print(wbt_license())

Prints the whitebox-tools version.

print(wbt_version())

Prints the toolbox for a specific tool.

print(wbt_toolbox())

List all available tools in whitebox-tools.

print(wbt_list_tools())

Lists tools with 'lidar' in tool name or description.

print(wbt_list_tools("lidar"))

Prints the help for a specific tool.

print(wbt_tool_help("lidar_info"))

Retrieves the tool parameter descriptions for a specific tool.

print(wbt_tool_parameters("slope"))

View the source code for a specific tool on the source code repository.

print(wbt_view_code("breach_depressions"))

How to run tools?

library(whitebox)
# Set input raster DEM file
dem <- system.file("extdata", "DEM.tif", package="whitebox")

# Run tools
wbt_feature_preserving_smoothing(dem, "./smoothed.tif", filter=9, verbose_mode = TRUE)
wbt_breach_depressions("./smoothed.tif", "./breached.tif")
wbt_d_inf_flow_accumulation(dem, "./flow_accum.tif")

whitebox documentation built on Sept. 7, 2020, 3 p.m.