From e24cda5a1c49c0ea36e88fe76cf1f6f4821500c5 Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Sun, 1 Oct 2023 08:55:12 -0700 Subject: [PATCH] Update documentation for WhiteboxTools settings for `compress_rasters`, `verbose_mode` --- PY2R/automation.py | 8 +- PY2R/scripts/data_tools.R | 216 +++--- PY2R/scripts/gis_analysis.R | 352 ++++----- PY2R/scripts/gis_analysis_distance.R | 48 +- PY2R/scripts/gis_analysis_overlay.R | 232 +++--- PY2R/scripts/gis_analysis_patch_shape.R | 112 +-- PY2R/scripts/hydro_analysis.R | 480 ++++++------ PY2R/scripts/image_analysis.R | 160 ++-- PY2R/scripts/image_analysis_classification.R | 48 +- PY2R/scripts/image_analysis_enhancement.R | 112 +-- PY2R/scripts/image_analysis_filters.R | 280 +++---- PY2R/scripts/lidar_analysis.R | 520 ++++++------- PY2R/scripts/machine_learning.R | 80 +- PY2R/scripts/math_stat_analysis.R | 720 +++++++++--------- PY2R/scripts/precision_agriculture.R | 48 +- PY2R/scripts/stream_network_analysis.R | 192 ++--- PY2R/scripts/terrain_analysis.R | 752 +++++++++---------- PY2R/scripts/whitebox_utilities.R | 16 +- R/data_tools.R | 216 +++--- R/gis_analysis.R | 352 ++++----- R/gis_analysis_distance.R | 48 +- R/gis_analysis_overlay.R | 232 +++--- R/gis_analysis_patch_shape.R | 112 +-- R/hydro_analysis.R | 480 ++++++------ R/image_analysis.R | 160 ++-- R/image_analysis_classification.R | 48 +- R/image_analysis_enhancement.R | 112 +-- R/image_analysis_filters.R | 280 +++---- R/lidar_analysis.R | 520 ++++++------- R/machine_learning.R | 80 +- R/math_stat_analysis.R | 720 +++++++++--------- R/precision_agriculture.R | 48 +- R/stream_network_analysis.R | 192 ++--- R/terrain_analysis.R | 752 +++++++++---------- R/whitebox_utilities.R | 16 +- 35 files changed, 4372 insertions(+), 4372 deletions(-) diff --git a/PY2R/automation.py b/PY2R/automation.py index e5efdf5e4..67108bda5 100644 --- a/PY2R/automation.py +++ b/PY2R/automation.py @@ -349,15 +349,15 @@ def function_example(fun_name): param = doc_line.replace("%", " percent") ff.write("#' @param {}\n".format(param)) i = i + 1 - ff.write("#' @param wd Changes the working directory.\n") + ff.write("#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details.\n") ff.write( - "#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages.\n" + "#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details.\n" ) ff.write( - "#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.\n" + "#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details.\n" ) ff.write( - "#' @param command_only Return command that would be executed by `system()` rather than running tool.\n" + "#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`.\n" ) ff.write("#'\n") ff.write("#' @keywords {}\n".format(tbx)) diff --git a/PY2R/scripts/data_tools.R b/PY2R/scripts/data_tools.R index 8c3cec1f7..9c3a0bca8 100644 --- a/PY2R/scripts/data_tools.R +++ b/PY2R/scripts/data_tools.R @@ -3,10 +3,10 @@ #' @description Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates. #' #' @param input Input vector Points file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -33,10 +33,10 @@ wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=NULL #' #' @param input Input vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -64,10 +64,10 @@ wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compress #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -95,10 +95,10 @@ wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=NULL #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -129,10 +129,10 @@ wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=NULL, #' @param xfield X field number (e.g. 0 for first field). #' @param yfield Y field number (e.g. 1 for second field). #' @param epsg EPSG projection (e.g. 2958). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -170,10 +170,10 @@ wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NUL #' @param input Input vector file. #' @param output Output csv file. #' @param headers Export field names as file header?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -205,10 +205,10 @@ wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbos #' @param input Name of the input lines vector file. #' @param output Name of the output lines vector file. #' @param dist Snap distance, in xy units (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -242,10 +242,10 @@ wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode= #' @param input2 Input foreign vector file (i.e. source of data to be imported). #' @param fkey Foreign key field. #' @param import_field Imported field (all fields will be imported if not specified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -278,10 +278,10 @@ wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NU #' #' @param input Input vector line file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -312,10 +312,10 @@ wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=NULL, com #' @param csv Input CSV file (i.e. source of data to be imported). #' @param fkey Foreign key field. #' @param import_field Imported field (all fields will be imported if not specified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -348,10 +348,10 @@ wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, #' #' @param inputs Input vector files. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -379,10 +379,10 @@ wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=NULL, compre #' #' @param input Input raster file. #' @param new_value New NoData value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -413,10 +413,10 @@ wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbo #' @param input Input vector line or polygon file. #' @param output Output vector line or polygon file. #' @param exclude_holes Exclude hole parts from the feature splitting? (holes will continue to belong to their features in output.). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -450,10 +450,10 @@ wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd= #' @param value Constant value to fill raster with; either 'nodata' or numeric value. #' @param data_type Output raster data type; options include 'double' (64-bit), 'float' (32-bit), and 'integer' (signed 16-bit) (default is 'float'). #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -490,10 +490,10 @@ wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="fl #' #' @param input Input vector polygon file. #' @param output Output vector lines file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -520,10 +520,10 @@ wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=NULL, com #' @description Prints the tags within a GeoTIFF. #' #' @param input Input GeoTIFF file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -550,10 +550,10 @@ wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=NULL, compress_ #' #' @param input Input raster lines file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -581,10 +581,10 @@ wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=NULL #' #' @param input Input raster file. #' @param output Output vector points file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -612,10 +612,10 @@ wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=NUL #' #' @param input Input raster file. #' @param output Output vector polygons file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -642,10 +642,10 @@ wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=N #' @description Reinitializes a vector's attribute table deleting all fields but the feature ID (FID). #' #' @param input Input vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -672,10 +672,10 @@ wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=NULL, #' #' @param input Input vector polygon file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -705,10 +705,10 @@ wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=NULL, #' @param output Name of the output raster file. #' @param threshold Maximum size of removed holes, in grid cells. Blank for no threshold, i.e. remove all holes. #' @param use_diagonals Use diagonal neighbours during clumping operation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -743,10 +743,10 @@ wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diag #' @param input Input raster file. #' @param output Output raster file. #' @param back_value Background value to set to nodata. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -778,10 +778,10 @@ wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose #' @param input Input vector line or polygon file. #' @param field Grouping ID field name in attribute table. #' @param output Output vector line or polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -816,10 +816,10 @@ wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, ve #' @param nodata Background value to set to NoData. Without this flag, it will be set to 0.0. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -864,10 +864,10 @@ wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, #' @param nodata Background value to set to NoData. Without this flag, it will be set to 0.0. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -914,10 +914,10 @@ wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last #' @param nodata Background value to set to NoData. Without this flag, it will be set to 0.0. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' diff --git a/PY2R/scripts/gis_analysis.R b/PY2R/scripts/gis_analysis.R index 26e68c95f..552b11101 100644 --- a/PY2R/scripts/gis_analysis.R +++ b/PY2R/scripts/gis_analysis.R @@ -6,10 +6,10 @@ #' @param output Output raster file. #' @param agg_factor Aggregation factor, in pixels. #' @param type Statistic used to fill output pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -47,10 +47,10 @@ wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NU #' @param output Output raster file. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -92,10 +92,10 @@ wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' @param output Output raster file. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -134,10 +134,10 @@ wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' @param input Input raster file. #' @param output Output raster file. #' @param text_output Optional text output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -168,10 +168,10 @@ wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode #' #' @param input Input vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -201,10 +201,10 @@ wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compr #' @param output Output raster file. #' @param diag Flag indicating whether diagonal connections should be considered. #' @param zero_back Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -241,10 +241,10 @@ wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbos #' @param use_z Use the 'z' dimension of the Shapefile's geometry instead of an attribute field?. #' @param output Output vector polygon file. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -283,10 +283,10 @@ wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max #' @param output Output vector polygon file. #' @param width The grid cell width. #' @param orientation Grid Orientation, 'horizontal' or 'vertical'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -321,10 +321,10 @@ wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation=" #' @param gradient Slope gradient in degrees (-85.0 to 85.0). #' @param aspect Aspect (direction) in degrees clockwise from north (0.0-360.0). #' @param constant Constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -365,10 +365,10 @@ wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant= #' @param height The grid cell height. #' @param xorig The grid origin x-coordinate. #' @param yorig The grid origin y-coordinate. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -406,10 +406,10 @@ wbt_create_rectangular_vector_grid <- function(input, output, width, height, xor #' @param field Dissolve field attribute (optional). #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -444,10 +444,10 @@ wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_m #' @param input Input vector file. #' @param output Output vector points file. #' @param tolerance The distance tolerance for points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -478,10 +478,10 @@ wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, v #' @param output Output vector polyline file. #' @param dist The distance to extend. #' @param extend Extend direction, 'both ends' (default), 'line start', 'line end'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -513,10 +513,10 @@ wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd= #' #' @param input Input vector lines or polygon file. #' @param output Output vector points file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -545,10 +545,10 @@ wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=NULL, compres #' @param inputs Input raster files. #' @param points Input vector points file. #' @param out_text Output point values as text? Otherwise, the only output is to to the points file's attribute table. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -581,10 +581,10 @@ wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, #' @param output Output raster file. #' @param threshold Remove features with fewer grid cells than this threshold value. #' @param background Background value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -617,10 +617,10 @@ wbt_filter_raster_features_by_area <- function(input, output, threshold, backgro #' @param input Input raster file. #' @param output Output vector points file. #' @param out_type Output type; one of 'area' (default) and 'volume'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -656,10 +656,10 @@ wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", #' @param kernel Kernel type; one of 'uniform', 'triangular', 'epanechnikov', 'quartic', 'triweight', 'tricube', 'gaussian', 'cosine', 'logistic', 'sigmoid', 'silverman'. #' @param cell_size Optionally specified cell size of output raster, in metres. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -709,10 +709,10 @@ wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel= #' @param min_points Minimum number of points. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -759,10 +759,10 @@ wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, #' #' @param input Input raster or vector file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -790,10 +790,10 @@ wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=NULL, compr #' #' @param input Input vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -823,10 +823,10 @@ wbt_medoid <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' @param output Output vector polygon file. #' @param criterion Minimization criterion; options include 'area' (default), 'length', 'width', and 'perimeter'. #' @param features Find the minimum bounding rectangles around each individual vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -861,10 +861,10 @@ wbt_minimum_bounding_box <- function(input, output, criterion="area", features=T #' @param input Input vector file. #' @param output Output vector polygon file. #' @param features Find the minimum bounding circle around each individual vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -896,10 +896,10 @@ wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, v #' @param input Input vector file. #' @param output Output vector polygon file. #' @param features Find the minimum bounding envelop around each individual vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -931,10 +931,10 @@ wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, #' @param input Input vector file. #' @param output Output vector polygon file. #' @param features Find the hulls around each vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -970,10 +970,10 @@ wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbo #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param clip Clip the data to the convex hull of the points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1021,10 +1021,10 @@ wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param max_dist Maximum search distance (optional). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1064,10 +1064,10 @@ wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, ce #' @description Calculates the area of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1094,10 +1094,10 @@ wbt_polygon_area <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input vector polygons file. #' @param output Output vector polyline file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1124,10 +1124,10 @@ wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=NULL, com #' @description Calculates the perimeter of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1154,10 +1154,10 @@ wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=NULL, compress_ra #' #' @param input Input vector polygons file. #' @param output Output vector polyline file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1194,10 +1194,10 @@ wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=NULL, co #' @param weight Weight parameter used in basis function. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1253,10 +1253,10 @@ wbt_radial_basis_function_interpolation <- function(input, field, output, use_z= #' @param out_text Would you like to output polygon areas to text?. #' @param units Area units; options include 'grid cells' and 'map units'. #' @param zero_back Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1296,10 +1296,10 @@ wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cell #' @param input Input raster file. #' @param output Output raster file. #' @param assign Which variable would you like to assign to grid cells? Options include 'column', 'row', 'x', and 'y'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1333,10 +1333,10 @@ wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, #' @param out_text Would you like to output polygon areas to text?. #' @param units Area units; options include 'grid cells' and 'map units'. #' @param zero_back Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1377,10 +1377,10 @@ wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid #' @param output Output raster file. #' @param reclass_vals Reclassification triplet values (new value; from value; to less than), e.g. '0.0;0.0;1.0;1.0;1.0;2.0'. #' @param assign_mode Optional Boolean flag indicating whether to operate in assign mode, reclass_vals values are interpreted as new value; old value pairs. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1415,10 +1415,10 @@ wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, #' @param interval Class interval size. #' @param start_val Optional starting value (default is input minimum value). #' @param end_val Optional ending value (default is input maximum value). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1456,10 +1456,10 @@ wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=N #' @param input Input raster file. #' @param reclass_file Input text file containing reclass ranges. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1489,10 +1489,10 @@ wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_ #' @param input Input vector POLYLINE or POLYGON file. #' @param output Output vector file. #' @param filter The filter size, any odd integer greater than or equal to 3; default is 3. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1524,10 +1524,10 @@ wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=NU #' @param input Name of the input lines shapefile. #' @param output Name of the output lines shapefile. #' @param length Maximum segment length (m). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1563,10 +1563,10 @@ wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_ #' @param resolution Output raster's grid resolution. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1610,10 +1610,10 @@ wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution= #' @param input Name of the input points shapefile. #' @param output Name of the output lines shapefile. #' @param duration Maximum duration, in seconds. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1646,10 +1646,10 @@ wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, #' @param output Output vector polygon file. #' @param width The grid cell width. #' @param orientation Grid Orientation, 'horizontal' or 'vertical'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1681,10 +1681,10 @@ wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal #' #' @param input Input vector points file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' diff --git a/PY2R/scripts/gis_analysis_distance.R b/PY2R/scripts/gis_analysis_distance.R index 6fbf71845..9fc730e51 100644 --- a/PY2R/scripts/gis_analysis_distance.R +++ b/PY2R/scripts/gis_analysis_distance.R @@ -6,10 +6,10 @@ #' @param output Output raster file. #' @param size Buffer size. #' @param gridcells Optional flag to indicate that the 'size' threshold should be measured in grid cells instead of the default map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -42,10 +42,10 @@ wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, ver #' @param source Input source raster file. #' @param backlink Input backlink raster file generated by the cost-distance tool. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -76,10 +76,10 @@ wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode= #' @param cost Input cost (friction) raster file. #' @param out_accum Output cost accumulation raster file. #' @param out_backlink Output backlink raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -111,10 +111,10 @@ wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, ve #' @param backlink Input backlink raster file generated by the cost-distance tool. #' @param output Output cost pathway raster file. #' @param zero_background Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -146,10 +146,10 @@ wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALS #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -177,10 +177,10 @@ wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=NULL, #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' diff --git a/PY2R/scripts/gis_analysis_overlay.R b/PY2R/scripts/gis_analysis_overlay.R index 3be465fff..2ab18b2e9 100644 --- a/PY2R/scripts/gis_analysis_overlay.R +++ b/PY2R/scripts/gis_analysis_overlay.R @@ -4,10 +4,10 @@ #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -36,10 +36,10 @@ wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, comp #' @param input Input vector file. #' @param clip Input clip polygon vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -70,10 +70,10 @@ wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=NULL, compress_r #' @param polygons Input vector polygons file. #' @param output Output raster file. #' @param maintain_dimensions Maintain input raster dimensions?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -106,10 +106,10 @@ wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensi #' @param inputs Input raster files. #' @param output Output raster file. #' @param value Search value (e.g. countif value = 5.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -139,10 +139,10 @@ wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=NULL, comp #' @param input Input vector file. #' @param overlay Input overlay vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -172,10 +172,10 @@ wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=NULL, c #' @param input Input vector file. #' @param erase Input erase polygon vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -205,10 +205,10 @@ wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=NULL, compress #' @param input Input raster file. #' @param polygons Input vector polygons file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -237,10 +237,10 @@ wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verb #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -270,10 +270,10 @@ wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, com #' @param overlay Input overlay vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -306,10 +306,10 @@ wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mod #' @param input1 Input vector polyline file. #' @param input2 Input vector polyline file. #' @param output Output vector point file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -338,10 +338,10 @@ wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -369,10 +369,10 @@ wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, comp #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -400,10 +400,10 @@ wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -432,10 +432,10 @@ wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress #' @param input Input vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -466,10 +466,10 @@ wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mo #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -497,10 +497,10 @@ wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -528,10 +528,10 @@ wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -560,10 +560,10 @@ wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, com #' @param inputs Input raster files. #' @param comparison Input comparison raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -593,10 +593,10 @@ wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mo #' @param inputs Input raster files. #' @param comparison Input comparison raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -626,10 +626,10 @@ wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbos #' @param inputs Input raster files. #' @param comparison Input comparison raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -659,10 +659,10 @@ wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_m #' @param inputs Input raster files. #' @param pos_input Input position raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -691,10 +691,10 @@ wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode= #' #' @param inputs Input vector polyline file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -723,10 +723,10 @@ wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_ #' @param input Input vector line or polygon file. #' @param split Input vector polyline file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -755,10 +755,10 @@ wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=NUL #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -788,10 +788,10 @@ wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress #' @param overlay Input overlay vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -825,10 +825,10 @@ wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL #' @param overlay Input overlay vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -861,10 +861,10 @@ wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NU #' @param input1 Input raster file 1. #' @param input2 Input raster file 2; update layer. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -897,10 +897,10 @@ wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mod #' @param constraints Input constraints raster files. #' @param output Output raster file. #' @param scale_max Suitability scale maximum value (common values are 1.0, 100.0, and 255.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -939,10 +939,10 @@ wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraint #' @param inputs Input raster files. #' @param weights Weight values, contained in quotes and separated by commas or semicolons. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' diff --git a/PY2R/scripts/gis_analysis_patch_shape.R b/PY2R/scripts/gis_analysis_patch_shape.R index 01e55ec3c..84d7987b9 100644 --- a/PY2R/scripts/gis_analysis_patch_shape.R +++ b/PY2R/scripts/gis_analysis_patch_shape.R @@ -4,10 +4,10 @@ #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -34,10 +34,10 @@ wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=N #' @description Calculates the compactness ratio (A/P), a measure of shape complexity, for vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -65,10 +65,10 @@ wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_ra #' @param input Input raster file. #' @param output Output raster file. #' @param output_text flag indicating whether a text report should also be output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -98,10 +98,10 @@ wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbo #' @description Calculates the elongation ratio for vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -128,10 +128,10 @@ wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_ras #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -158,10 +158,10 @@ wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_m #' @description Calculates the proportion of the total area of a polygon's holes relative to the area of the polygon's hull. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -187,10 +187,10 @@ wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=NULL, compress_rast #' @description Calculates the linearity index for vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -217,10 +217,10 @@ wbt_linearity_index <- function(input, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -247,10 +247,10 @@ wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=NULL, comp #' @description Calculates the orientation of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -276,10 +276,10 @@ wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=NULL, compress_ra #' @description Calculates the perimeter-area ratio of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -307,10 +307,10 @@ wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress #' @param input Input raster file. #' @param output Output raster file. #' @param text_output Optional text output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -340,10 +340,10 @@ wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, ve #' @description Calculates the related circumscribing circle of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -369,10 +369,10 @@ wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=NULL, #' @description Calculates overall polygon shape complexity or irregularity. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -399,10 +399,10 @@ wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=NULL, compre #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' diff --git a/PY2R/scripts/hydro_analysis.R b/PY2R/scripts/hydro_analysis.R index ef1712405..ae5ddbde5 100644 --- a/PY2R/scripts/hydro_analysis.R +++ b/PY2R/scripts/hydro_analysis.R @@ -4,10 +4,10 @@ #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -35,10 +35,10 @@ wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=NULL, #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -67,10 +67,10 @@ wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mo #' @param d8_pntr Input raster D8 pointer file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -105,10 +105,10 @@ wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=N #' @param max_length Optional maximum breach channel length (in grid cells; default is Inf). #' @param flat_increment Optional elevation increment applied to flat areas. #' @param fill_pits Optional flag indicating whether to fill single-cell pits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -153,10 +153,10 @@ wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, #' @param min_dist Optional flag indicating whether to minimize breach distances. #' @param flat_increment Optional elevation increment applied to flat areas. #' @param fill Optional flag indicating whether to fill any remaining unbreached depressions. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -197,10 +197,10 @@ wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -231,10 +231,10 @@ wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, #' @param roads Input vector roads file. #' @param output Output raster file. #' @param width Maximum road embankment width, in map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -272,10 +272,10 @@ wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, w #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param pntr Is the input raster a D8 flow pointer rather than a DEM?. #' @param esri_pntr Input D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -321,10 +321,10 @@ wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, #' @param efficiency Input efficiency raster file. #' @param absorption Input absorption raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -356,10 +356,10 @@ wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NU #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -395,10 +395,10 @@ wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=N #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param pntr Is the input raster a D-infinity flow pointer rather than a DEM?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -444,10 +444,10 @@ wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contri #' @param efficiency Input efficiency raster file. #' @param absorption Input absorption raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -478,10 +478,10 @@ wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -510,10 +510,10 @@ wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_ #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param zero_background Flag indicating whether the background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -546,10 +546,10 @@ wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbo #' @param streams Name of the input streams vector (optional). #' @param lakes Name of the input lakes vector (optional). #' @param output Name of the output raster image file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -585,10 +585,10 @@ wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, v #' @param streams Input raster streams file. #' @param output Output raster file. #' @param dinf Use the D-infinity flow algorithm instead of D8?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -623,10 +623,10 @@ wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, w #' @param weights Optional input weights raster file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -665,10 +665,10 @@ wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weig #' @param output Name of the output raster file. #' @param flow_type Flow algorithm type, one of 'd8', 'mfd', or 'dinf'. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -703,10 +703,10 @@ wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd= #' @param dem Input raster DEM file. #' @param streams Input raster streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -736,10 +736,10 @@ wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mo #' @param dem Input raster DEM file. #' @param streams Input raster streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -773,10 +773,10 @@ wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -819,10 +819,10 @@ wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributi #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -851,10 +851,10 @@ wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param dem Input raster DEM file. #' @param streams Input vector streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -886,10 +886,10 @@ wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, comp #' @param fix_flats Optional flag indicating whether flat areas should have a small gradient applied. #' @param flat_increment Optional elevation increment applied to flat areas. #' @param max_depth Optional maximum depression depth to fill. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -928,10 +928,10 @@ wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NUL #' @param output Output raster file. #' @param fix_flats Optional flag indicating whether flat areas should have a small gradient applied. #' @param flat_increment Optional elevation increment applied to flat areas. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -967,10 +967,10 @@ wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRU #' @param output Output raster file. #' @param fix_flats Optional flag indicating whether flat areas should have a small gradient applied. #' @param flat_increment Optional elevation increment applied to flat areas. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1004,10 +1004,10 @@ wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_ #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1035,10 +1035,10 @@ wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, c #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1067,10 +1067,10 @@ wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=NULL, comp #' @param d8_pntr Input D8 pointer raster file. #' @param streams Input raster streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1100,10 +1100,10 @@ wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mo #' @param dem Input raster DEM file. #' @param lakes Input lakes vector polygons file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1132,10 +1132,10 @@ wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=NULL, co #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1169,10 +1169,10 @@ wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1215,10 +1215,10 @@ wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accu #' @param d8_pntr Input D8 pointer raster file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1251,10 +1251,10 @@ wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verb #' @param streams Input raster streams file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1289,10 +1289,10 @@ wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, v #' @param output2 Name of the output upslope disconnected saturated area (UDSA) file. #' @param exponent Optional exponent parameter; default is 1.0. #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1332,10 +1332,10 @@ wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, thr #' @param out_area Output flooded area file. #' @param out_dam_height Output dam height file. #' @param damlength Maximum length of the dam. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1380,10 +1380,10 @@ wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NU #' @param dam_pts Input vector dam points file. #' @param output Output file. #' @param damlength Maximum length of the dam. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1415,10 +1415,10 @@ wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mo #' @param output Output raster file. #' @param size Target basin size, in grid cells. #' @param connections Output upstream-downstream flow connections among basins?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1452,10 +1452,10 @@ wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose #' @param streams Input raster streams file. #' @param output Output vector file. #' @param snap_dist Maximum snap distance in map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1486,10 +1486,10 @@ wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd #' @param dem Input raster DEM file. #' @param basins Input raster basins file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1519,10 +1519,10 @@ wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=NULL #' @param dem Name of the input DEM raster file. #' @param streams Name of the input stream channel raster file. #' @param output Name of the output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1551,10 +1551,10 @@ wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, v #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1583,10 +1583,10 @@ wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=N #' @param dem Input DEM; it must be depressionless. #' @param values Name of the input values raster file. #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1620,10 +1620,10 @@ wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=NUL #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1666,10 +1666,10 @@ wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contrib #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1703,10 +1703,10 @@ wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Log-transform the output values?. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1757,10 +1757,10 @@ wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributi #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Log-transform the output values?. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1806,10 +1806,10 @@ wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contribu #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param height Wall height. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1849,10 +1849,10 @@ wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NU #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param pntr Is the input raster a Rho8 flow pointer rather than a DEM?. #' @param esri_pntr Does the input Rho8 pointer use the ESRI style scheme?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1896,10 +1896,10 @@ wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contrib #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1932,10 +1932,10 @@ wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode #' @param output Name of the output vector lines file. #' @param min_length Minimum line length, in grid cells. #' @param radius Search radius for joining distant endnodes, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1970,10 +1970,10 @@ wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL #' @param input Input raster DEM file. #' @param output Output raster file. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2006,10 +2006,10 @@ wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode #' @param flow_accum Input raster D8 flow accumulation file. #' @param output Output vector file. #' @param snap_dist Maximum snap distance in map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2042,10 +2042,10 @@ wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NUL #' @param rmse The DEM's root-mean-square-error (RMSE), in z units. This determines error magnitude. #' @param range The error field's correlation length, in xy-units. #' @param iterations The number of iterations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2080,10 +2080,10 @@ wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterati #' @param streams Input raster streams file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2117,10 +2117,10 @@ wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param streams Input raster streams file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2155,10 +2155,10 @@ wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, ve #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2195,10 +2195,10 @@ wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=F #' @param pour_pts Input vector pour points (outlet) file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2230,10 +2230,10 @@ wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NUL #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2263,10 +2263,10 @@ wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=NU #' @param pour_pts Input pour points (outlet) file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' diff --git a/PY2R/scripts/image_analysis.R b/PY2R/scripts/image_analysis.R index e5f37393d..afae272f6 100644 --- a/PY2R/scripts/image_analysis.R +++ b/PY2R/scripts/image_analysis.R @@ -6,10 +6,10 @@ #' @param date2 Input raster files for the later date. #' @param magnitude Output vector magnitude raster file. #' @param direction Output vector Direction raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -41,10 +41,10 @@ wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NU #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -83,10 +83,10 @@ wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' @param output Output colour composite file. #' @param enhance Optional flag indicating whether a balance contrast enhancement is performed. #' @param zeros Optional flag to indicate if zeros are nodata values. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -126,10 +126,10 @@ wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, #' @param input Input raster file. #' @param output Output raster file. #' @param direction Direction of reflection; options include 'v' (vertical), 'h' (horizontal), and 'b' (both). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -165,10 +165,10 @@ wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose #' @param green Output green band file. Optionally specified if colour-composite not specified. #' @param blue Output blue band file. Optionally specified if colour-composite not specified. #' @param output Output colour-composite file. Only used if individual bands are not specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -217,10 +217,10 @@ wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' @param label2 Right image label (leave blank for none). #' @param output Name of the output HTML file (*.html). #' @param height Image height, in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -271,10 +271,10 @@ wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=F #' @param inputs Input multispectral image files. #' @param points Input vector points file. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -303,10 +303,10 @@ wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mod #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -334,10 +334,10 @@ wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=NULL, compre #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -366,10 +366,10 @@ wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=NULL, compres #' @param inputs Input raster files. #' @param output Output raster file. #' @param method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -405,10 +405,10 @@ wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=N #' @param output Output raster file. #' @param method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution). #' @param weight . -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -446,10 +446,10 @@ wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weig #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. #' @param correction Optional adjustment value (e.g. 1, or 0.16 for the optimal soil adjusted vegetation index, OSAVI). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -486,10 +486,10 @@ wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, co #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -524,10 +524,10 @@ wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' @param input Input raster file. #' @param output Output raster file. #' @param iterations Maximum number of iterations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -561,10 +561,10 @@ wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -606,10 +606,10 @@ wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", #' @param intensity Output intensity raster file. #' @param hue Output hue raster file. #' @param saturation Output saturation raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -652,10 +652,10 @@ wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' @param red Output red band file. #' @param green Output green band file. #' @param blue Output blue band file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -691,10 +691,10 @@ wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, w #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -725,10 +725,10 @@ wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=NULL, c #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param variant Optional variant value. Options include 'white' and 'black'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -767,10 +767,10 @@ wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant= #' @param input2 Input raster file associated with the second date. #' @param input3 Optional input raster file associated with the third date. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' diff --git a/PY2R/scripts/image_analysis_classification.R b/PY2R/scripts/image_analysis_classification.R index e0040119b..97289ebaa 100644 --- a/PY2R/scripts/image_analysis_classification.R +++ b/PY2R/scripts/image_analysis_classification.R @@ -6,10 +6,10 @@ #' @param polys Name of the input training site polygons shapefile. #' @param field Name of the attribute containing class name data. #' @param output Name of the output report file (*.html). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -41,10 +41,10 @@ wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, v #' @param output Name of the output raster file. #' @param min_size Minimum feature size, in grid cells. #' @param method Grouping method; one of 'longest' (default), 'largest', and 'nearest'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -80,10 +80,10 @@ wbt_generalize_classified_raster <- function(input, output, min_size=4, method=" #' @param similarity Names of the input similarity images. #' @param output Name of the output raster file. #' @param min_size Minimum feature size, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -118,10 +118,10 @@ wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4 #' @param threshold Distance threshold, in z-scores. #' @param steps Number of steps. #' @param min_area Minimum object area, in grid cells (1-8). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -161,10 +161,10 @@ wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_ #' @param field Name of the attribute containing class name data. #' @param output Name of the output raster file. #' @param threshold Distance threshold, in z-scores; blank for none. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -199,10 +199,10 @@ wbt_min_dist_classification <- function(inputs, polys, field, output, threshold= #' @param polys Name of the input training site polygons shapefile. #' @param field Name of the attribute containing class name data. #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' diff --git a/PY2R/scripts/image_analysis_enhancement.R b/PY2R/scripts/image_analysis_enhancement.R index 7ebce27ef..ea555012c 100644 --- a/PY2R/scripts/image_analysis_enhancement.R +++ b/PY2R/scripts/image_analysis_enhancement.R @@ -5,10 +5,10 @@ #' @param input Input colour composite image file. #' @param output Output raster file. #' @param band_mean Band mean value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -43,10 +43,10 @@ wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd= #' @param focal_length Camera focal length, in millimeters. #' @param image_width Distance between photograph edges, in millimeters. #' @param n The 'n' parameter. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -86,10 +86,10 @@ wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_ #' @param output Output raster file. #' @param k Achromatic factor (k) ranges between 0 (no effect) and 1 (full saturation stretch), although typical values range from 0.3 to 0.7. #' @param clip Optional percent to clip the upper tail by during the stretch. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -124,10 +124,10 @@ wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd= #' @param input Input raster file. #' @param output Output raster file. #' @param gamma Gamma value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -159,10 +159,10 @@ wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode #' @param input Input raster file. #' @param output Output raster file. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -194,10 +194,10 @@ wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, #' @param input Input raster file. #' @param output Output raster file. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -229,10 +229,10 @@ wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, ve #' @param input Input raster file. #' @param histo_file Input reference probability distribution function (pdf) text file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -262,10 +262,10 @@ wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_m #' @param input1 Input raster file to modify. #' @param input2 Input reference raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -297,10 +297,10 @@ wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, v #' @param min_val Lower tail clip value. #' @param max_val Upper tail clip value. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -338,10 +338,10 @@ wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_to #' @param pan Input panchromatic band file. #' @param output Output colour composite file. #' @param method Options include 'brovey' (default) and 'ihs'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -387,10 +387,10 @@ wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue= #' @param clip Optional amount to clip the distribution tails by, in percent. #' @param tail Specified which tails to clip; options include 'upper', 'lower', and 'both' (default is 'both'). #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -429,10 +429,10 @@ wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both" #' @param output Name of the output raster image file. #' @param FUN Piecewise break-points e.g. '(50, 0.1); (150, 0.8); (255; 1.0). #' @param greytones Number of greytones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -469,10 +469,10 @@ wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024 #' @param cutoff Cutoff value between 0.0 and 0.95. #' @param gain Gain value. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -511,10 +511,10 @@ wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, #' @param output Output raster file. #' @param stdev Standard deviation clip value. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' diff --git a/PY2R/scripts/image_analysis_filters.R b/PY2R/scripts/image_analysis_filters.R index f7e4a2af4..8f6e8cac9 100644 --- a/PY2R/scripts/image_analysis_filters.R +++ b/PY2R/scripts/image_analysis_filters.R @@ -7,10 +7,10 @@ #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param threshold Difference from mean threshold, in standard deviations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -49,10 +49,10 @@ wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold #' @param output Output raster file. #' @param sigma_dist Standard deviation in distance in pixels. #' @param sigma_int Standard deviation in intensity in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -90,10 +90,10 @@ wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, #' @param low Low threshold, default = 0.05. #' @param high High threshold, default = 0.15. #' @param add_back Add the edge cells back to the input image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -135,10 +135,10 @@ wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0. #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -172,10 +172,10 @@ wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery= #' #' @param input Input boolean image. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -205,10 +205,10 @@ wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=NULL, comp #' @param output Output raster file. #' @param sigma1 Standard deviation distance in pixels. #' @param sigma2 Standard deviation distance in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -244,10 +244,10 @@ wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, w #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -283,10 +283,10 @@ wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' @param output Output raster file. #' @param filter Size of the filter kernel. #' @param threshold Maximum difference in values. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -320,10 +320,10 @@ wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, #' @param output Output raster file. #' @param direction Direction of reflection; options include 'n', 's', 'e', 'w', 'ne', 'se', 'nw', 'sw'. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -358,10 +358,10 @@ wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, v #' @param input Input raster file. #' @param output Output raster file. #' @param sigma Standard deviation distance in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -393,10 +393,10 @@ wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, v #' @param input Input raster file. #' @param output Output raster file. #' @param sigma Standard deviation distance in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -429,10 +429,10 @@ wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode #' @param output Output raster file. #' @param sigma_dist Standard deviation in distance in pixels. #' @param sigma_int Standard deviation in intensity in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -468,10 +468,10 @@ wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -508,10 +508,10 @@ wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -551,10 +551,10 @@ wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, s #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param k k-value in pixels; this is the number of nearest-valued neighbours to use. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -593,10 +593,10 @@ wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5 #' @param output Output raster file. #' @param variant Optional variant value. Options include 3x3(1), 3x3(2), 3x3(3), 3x3(4), 5x5(1), and 5x5(2) (default is 3x3(1)). #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -631,10 +631,10 @@ wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=N #' @param input Input raster file. #' @param output Output raster file. #' @param sigma Standard deviation in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -669,10 +669,10 @@ wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, #' @param filtery Size of the filter kernel in the y-direction. #' @param sigma Sigma value should be related to the standard deviation of the distribution of image speckle noise. #' @param m M-threshold value the minimum allowable number of pixels within the intensity range. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -715,10 +715,10 @@ wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10 #' @param variant Optional variant value. Options include 'v' (vertical), 'h' (horizontal), '45', and '135' (default is 'v'). #' @param absvals Optional flag indicating whether outputs should be absolute values. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -757,10 +757,10 @@ wbt_line_detection_filter <- function(input, output, variant="vertical", absvals #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -796,10 +796,10 @@ wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -835,10 +835,10 @@ wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -875,10 +875,10 @@ wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbos #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -917,10 +917,10 @@ wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits= #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -956,10 +956,10 @@ wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -996,10 +996,10 @@ wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1037,10 +1037,10 @@ wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_dig #' @param input Input raster file. #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1073,10 +1073,10 @@ wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NU #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1111,10 +1111,10 @@ wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' @param input Input raster file. #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1146,10 +1146,10 @@ wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_m #' @param input Input raster file. #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1182,10 +1182,10 @@ wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NUL #' @param output Output raster file. #' @param variant Optional variant value. Options include 3x3 and 5x5 (default is 3x3). #' @param clip Optional amount to clip the distribution tails by, in percent (default is 0.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1221,10 +1221,10 @@ wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, ve #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1260,10 +1260,10 @@ wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1300,10 +1300,10 @@ wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' @param sigma Standard deviation distance in pixels. #' @param amount A percentage and controls the magnitude of each overshoot. #' @param threshold Controls the minimal brightness change that will be sharpened. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1343,10 +1343,10 @@ wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, thresho #' @param output Output raster file. #' @param center Kernel center cell; options include 'center', 'upper-left', 'upper-right', 'lower-left', 'lower-right'. #' @param normalize Normalize kernel weights? This can reduce edge effects and lessen the impact of data gaps (nodata) but is not suited when the kernel weights sum to zero. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' diff --git a/PY2R/scripts/lidar_analysis.R b/PY2R/scripts/lidar_analysis.R index ff6d936ee..5a7865441 100644 --- a/PY2R/scripts/lidar_analysis.R +++ b/PY2R/scripts/lidar_analysis.R @@ -5,10 +5,10 @@ #' @param inputs Input LiDAR ASCII files (.csv). #' @param pattern Input field pattern. #' @param proj Well-known-text string or EPSG code describing projection. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -40,10 +40,10 @@ wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=N #' @param input Input LiDAR file. #' @param buildings Input vector polygons file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -79,10 +79,10 @@ wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, v #' @param linearity_threshold Linearity threshold (0-1). #' @param iterations Number of iterations. #' @param facade_threshold Facade threshold (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -136,10 +136,10 @@ wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1 #' @param resolution The size of the square area used to evaluate nearby points in the LiDAR data. #' @param criterion Criterion used to identify overlapping points; options are 'max scan angle', 'not min point source ID', 'not min time', 'multiple point source IDs'. #' @param filter Filter out points from overlapping flightlines? If false, overlaps will simply be classified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -177,10 +177,10 @@ wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion #' @param input Input LiDAR file. #' @param polygons Input vector polygons file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -213,10 +213,10 @@ wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_ #' @param clr_str Colour values, e.g. 2: (184, 167, 108); 5: #9ab86c. #' @param use_unique_clrs_for_buildings Use unique colours for each building?. #' @param radius Search distance used in neighbourhood search. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -263,10 +263,10 @@ wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending= #' @param first First return colour, e.g. (230,214,170), #e6d6aa, or 0xe6d6aa. #' @param intermediate Intermediate return colour, e.g. (230,214,170), #e6d6aa, or 0xe6d6aa. #' @param last Last return colour, e.g. (230,214,170), #e6d6aa, or 0xe6d6aa. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -316,10 +316,10 @@ wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_b #' @param input Input LiDAR file. #' @param polygons Input vector polygons file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -349,10 +349,10 @@ wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbo #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. #' @param statement Filter statement e.g. x < 5000.0 && y > 100.0 && is_late && !is_noise. This statement must be a valid Rust statement. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -386,10 +386,10 @@ wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -421,10 +421,10 @@ wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, v #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param threshold Scan angle threshold. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -453,10 +453,10 @@ wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verb #' #' @param input Input LiDAR file. #' @param output Output file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -485,10 +485,10 @@ wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode #' @param input Input LiDAR file. #' @param output Output file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -521,10 +521,10 @@ wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @param input Input LiDAR file (including extension). #' @param output Output lidar file (including extension). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -559,10 +559,10 @@ wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=NU #' @param max_search_radius Maximum search radius (m). #' @param max_height Maximum height (m). #' @param only_use_veg Only use veg. class points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -606,10 +606,10 @@ wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius= #' @description Converts one or more LAS files into ASCII text files. #' #' @param inputs Input LiDAR files. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -636,10 +636,10 @@ wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=NULL, compress_raster #' #' @param input Name of the input LAS files (leave blank to use all LAS files in WorkingDirectory. #' @param output Output LAZ file (including extension). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -668,10 +668,10 @@ wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compr #' @description Converts one or more LAS files into MultipointZ vector Shapefiles. When the input parameter is not specified, the tool grids all LAS files contained within the working directory. #' #' @param input Input LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -697,10 +697,10 @@ wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=NULL, c #' @description Converts one or more LAS files into a vector Shapefile of POINT ShapeType. #' #' @param input Input LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -729,10 +729,10 @@ wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=NULL, compress_ras #' @param outdir Output directory into which zlidar files are created. If unspecified, it is assumed to be the same as the inputs. #' @param compress Compression method, including 'brotli' and 'deflate'. #' @param level Compression level (1-9). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -770,10 +770,10 @@ wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level #' #' @param input Name of the input LAZ files (leave blank to use all LAZ files in WorkingDirectory. #' @param output Output LAS file (including extension). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -804,10 +804,10 @@ wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compr #' @param input Input LiDAR file. #' @param output Output file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -841,10 +841,10 @@ wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' @param input Input LiDAR file. #' @param output Output file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -880,10 +880,10 @@ wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' @param output Output LiDAR file. #' @param subset_class Subset point class value (must be 0-18; see LAS specifications). #' @param nonsubset_class Non-subset point class value (must be 0-18; see LAS specifications). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -917,10 +917,10 @@ wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsub #' @param in_lidar Input LiDAR file. #' @param in_image Input colour image file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -958,10 +958,10 @@ wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mod #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1023,10 +1023,10 @@ wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smoot #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1072,10 +1072,10 @@ wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, #' @param input Name of the input LiDAR points. #' @param num_neighbours Number of neighbours used in search. #' @param radius Search distance used in neighbourhood search. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1113,10 +1113,10 @@ wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NUL #' @param cls Optional boolean flag indicating whether points outside the range should be retained in output but reclassified. #' @param inclassval Optional parameter specifying the class value assigned to points within the slice. #' @param outclassval Optional parameter specifying the class value assigned to points within the slice. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1166,10 +1166,10 @@ wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=F #' @param classify Classify points as ground (2) or off-ground (1). #' @param slope_norm Perform initial ground slope normalization?. #' @param height_above_ground Transform output to height above average ground elevation?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1220,10 +1220,10 @@ wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbo #' @param output Output vector polygon file. #' @param width The grid cell width. #' @param orientation Grid Orientation, 'horizontal' or 'vertical'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1258,10 +1258,10 @@ wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal" #' @param azimuth Illumination source azimuth in degrees. #' @param altitude Illumination source altitude in degrees. #' @param radius Search Radius. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1300,10 +1300,10 @@ wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, rad #' @param output Output HTML file (default name will be based on input file if unspecified). #' @param parameter Parameter; options are 'elevation' (default), 'intensity', 'scan angle', 'class', 'time'. #' @param clip Amount to clip distribution tails (in percent). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1345,10 +1345,10 @@ wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1405,10 +1405,10 @@ wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation #' @param density Flag indicating whether or not to calculate the average point density and nominal point spacing. #' @param vlr Flag indicating whether or not to print the variable length records (VLRs). #' @param geokeys Flag indicating whether or not to print the geokeys. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1445,10 +1445,10 @@ wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, #' #' @param inputs Input LiDAR files. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1479,10 +1479,10 @@ wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_ #' @param output Output HTML file. #' @param class_accuracy Output classification accuracy raster file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1522,10 +1522,10 @@ wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolu #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1582,10 +1582,10 @@ wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter=" #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1633,10 +1633,10 @@ wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolutio #' #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1672,10 +1672,10 @@ wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose #' @param z_range Flag indicating whether or not to output the elevation range raster. #' @param intensity_range Flag indicating whether or not to output the intensity range raster. #' @param predom_class Flag indicating whether or not to output the predominant classification raster. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1731,10 +1731,10 @@ wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pu #' @param max_slope Maximum planar slope. #' @param classify Classify points as ground (2) or off-ground (1). #' @param last_returns Only include last- and only-return points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1796,10 +1796,10 @@ wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_ #' @param func_type Radial basis function type; options are 'ThinPlateSpline' (default), 'PolyHarmonic', 'Gaussian', 'MultiQuadric', 'InverseMultiQuadric'. #' @param poly_order Polynomial order; options are 'none' (default), 'constant', 'affine'. #' @param weight Weight parameter used in basis function. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1860,10 +1860,10 @@ wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param include_z Include z-values in point comparison?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1898,10 +1898,10 @@ wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, #' @param elev_diff Max. elevation difference. #' @param use_median Optional flag indicating whether to use the difference from median elevation rather than mean. #' @param classify Classify points as ground (2) or off-ground (1). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1951,10 +1951,10 @@ wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, #' @param norm_diff Maximum difference in normal vectors, in degrees. #' @param azimuth Illumination source azimuth, in degrees. #' @param altitude Illumination source altitude in degrees. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2022,10 +2022,10 @@ wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0 #' @param maxzdiff Maximum difference in elevation (z units) between neighbouring points of the same segment. #' @param classes Segments don't cross class boundaries. #' @param ground Classify the largest segment as ground points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2087,10 +2087,10 @@ wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_s #' @param norm_diff Maximum difference in normal vectors, in degrees. #' @param maxzdiff Maximum difference in elevation (z units) between neighbouring points of the same segment. #' @param classify Classify points as ground (2) or off-ground (1). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2133,10 +2133,10 @@ wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_ #' @param x_shift x-shift value, blank for none. #' @param y_shift y-shift value, blank for none. #' @param z_shift z-shift value, blank for none. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2179,10 +2179,10 @@ wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", w #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2230,10 +2230,10 @@ wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevat #' #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2264,10 +2264,10 @@ wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=NULL, co #' @param resolution The size of the square area used to evaluate nearby points in the LiDAR data. #' @param method Point selection method; options are 'first', 'last', 'lowest' (default), 'highest', 'nearest'. #' @param save_filtered Save filtered points to separate file?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2307,10 +2307,10 @@ wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_ #' @param resolution Output raster's grid resolution. #' @param density Max. point density (points / m^3). #' @param save_filtered Save filtered points to separate file?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2349,10 +2349,10 @@ wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, #' @param origin_x Origin point X coordinate for tile grid. #' @param origin_y Origin point Y coordinate for tile grid. #' @param min_points Minimum number of points contained in a tile for it to be saved. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2395,10 +2395,10 @@ wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, ori #' @param input Input LiDAR file. #' @param output Output vector polygon file. #' @param hull Identify the convex hull around points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2436,10 +2436,10 @@ wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2491,10 +2491,10 @@ wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", re #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param radius Search Radius. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2526,10 +2526,10 @@ wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbo #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. #' @param statement Modify statement e.g. x += 5000.0. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2563,10 +2563,10 @@ wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param radius Search Radius. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2598,10 +2598,10 @@ wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode= #' @param input Name of the input LiDAR file. #' @param output Name of the output LiDAR file. #' @param dtm Name of the input digital terrain model (DTM) raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2634,10 +2634,10 @@ wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=NULL, #' @param pt_src_id Add flightline information to the point source ID. #' @param user_data Add flightline information to the user data. #' @param rgb Add flightline information to the RGB colour data. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2678,10 +2678,10 @@ wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src #' @param indir Input LAS file source directory. #' @param outdir Output directory into which LAS files within the polygon are copied. #' @param polygons Input vector polygons file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2711,10 +2711,10 @@ wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbos #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. #' @param criteria Sort criteria e.g. 'x 50.0, y 50.0, z'; criteria may include x, y, z, intensity, class, user_data, point_source_id, and scan_angle. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2749,10 +2749,10 @@ wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mod #' @param criterion Criterion on which to base the split of the input file. Options include 'num_pts, 'x', 'y', 'z', intensity, 'class', 'user_data', 'point_source_id', 'scan_angle', 'time'. #' @param interval Interval. #' @param min_pts Minimum number of points in an output file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2788,10 +2788,10 @@ wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, #' #' @param inputs Input ZLidar files. #' @param outdir Output directory into which zlidar files are created. If unspecified, it is assumed to be the same as the inputs. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' diff --git a/PY2R/scripts/machine_learning.R b/PY2R/scripts/machine_learning.R index 76327f5b5..98a57e364 100644 --- a/PY2R/scripts/machine_learning.R +++ b/PY2R/scripts/machine_learning.R @@ -7,10 +7,10 @@ #' @param output Name of the output raster file. #' @param search_dist Search-distance parameter. #' @param min_points Minimum point density needed to define 'core' point in cluster. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -53,10 +53,10 @@ wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, mi #' @param class_change Minimum percent of cells changed between iterations before completion. #' @param initialize How to initialize cluster centres?. #' @param min_class_size Minimum class size, in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -106,10 +106,10 @@ wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_i #' @param k k-parameter, which determines the number of nearest neighbours used. #' @param clip Perform training data clipping to remove outlier pixels?. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -159,10 +159,10 @@ wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", #' @param k k-parameter, which determines the number of nearest neighbours used. #' @param weight Use distance weighting?. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -210,10 +210,10 @@ wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", out #' @param field Name of the attribute containing class data. #' @param output Name of the output raster file. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -256,10 +256,10 @@ wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize" #' @param merge_dist Cluster merger distance. #' @param max_iterations Maximum number of iterations. #' @param class_change Minimum percent of cells changed between iterations before completion. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -309,10 +309,10 @@ wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start #' @param min_samples_leaf The minimum number of samples required to be at a leaf node. #' @param min_samples_split The minimum number of samples required to split an internal node. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -365,10 +365,10 @@ wbt_random_forest_classification <- function(inputs, training, field, output=NUL #' @param min_samples_leaf The minimum number of samples required to be at a leaf node. #' @param min_samples_split The minimum number of samples required to split an internal node. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -419,10 +419,10 @@ wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n #' @param gamma Gamma parameter used in setting the RBF (Gaussian) kernel function. #' @param tolerance The tolerance parameter used in determining the stopping condition. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -476,10 +476,10 @@ wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", #' @param eps Epsilon in the epsilon-SVR model. #' @param gamma Gamma parameter used in setting the RBF (Gaussian) kernel function. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' diff --git a/PY2R/scripts/math_stat_analysis.R b/PY2R/scripts/math_stat_analysis.R index a8fa5e57a..c1b2b9a5c 100644 --- a/PY2R/scripts/math_stat_analysis.R +++ b/PY2R/scripts/math_stat_analysis.R @@ -5,10 +5,10 @@ #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -38,10 +38,10 @@ wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -71,10 +71,10 @@ wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -103,10 +103,10 @@ wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_ #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -135,10 +135,10 @@ wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=NULL, compre #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -168,10 +168,10 @@ wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input Input raster file. #' @param features Feature definition (or class) raster. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -200,10 +200,10 @@ wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=NULL, compr #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -231,10 +231,10 @@ wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -262,10 +262,10 @@ wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -293,10 +293,10 @@ wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -324,10 +324,10 @@ wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -355,10 +355,10 @@ wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -387,10 +387,10 @@ wbt_artanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' @param input_y Input y raster file or constant value (rise). #' @param input_x Input x raster file or constant value (run). #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -419,10 +419,10 @@ wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=NULL, comp #' #' @param input Input vector file. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -456,10 +456,10 @@ wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode= #' @param radius Search Radius (in map units). #' @param min_points Minimum number of points. #' @param stat Correlation type; one of 'pearson' (default) and 'spearman'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -498,10 +498,10 @@ wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, fiel #' @param input Input vector file. #' @param field Input field name in attribute table. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -533,10 +533,10 @@ wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode= #' @param fieldy Input field name in attribute table for the y-axis. #' @param output Output HTML file (default name will be based on input file if unspecified). #' @param trendline Draw the trendline. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -569,10 +569,10 @@ wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=F #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -603,10 +603,10 @@ wbt_ceil <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' @param true Value where condition evaluates TRUE (input raster or constant value). #' @param false Value where condition evaluates FALSE (input raster or constant value). #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -652,10 +652,10 @@ wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, f #' @param temp_decay Annealing temperature decay proportion between `[0,1]`. Reduce temperature by this proportion each annealing cycle. #' @param cycle Number of iterations before decaying annealing temperature. #' @param average Weight the continuous objective funtion by the 1/N contributing strata. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -710,10 +710,10 @@ wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterati #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -741,10 +741,10 @@ wbt_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -772,10 +772,10 @@ wbt_cosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Optional output html file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -806,10 +806,10 @@ wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, #' @param input1 Input raster file 1. #' @param input2 Input raster file 1. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -838,10 +838,10 @@ wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=N #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -869,10 +869,10 @@ wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=NUL #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -901,10 +901,10 @@ wbt_decrement <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -934,10 +934,10 @@ wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compr #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -966,10 +966,10 @@ wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -997,10 +997,10 @@ wbt_exp <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1028,10 +1028,10 @@ wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1061,10 +1061,10 @@ wbt_floor <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raster #' @param input2 Input raster file or constant value. #' @param output Output raster file. #' @param incl_equals Perform a greater-than-or-equal-to operation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1097,10 +1097,10 @@ wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, #' @param inputs Input raster files. #' @param contiguity Contiguity type. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1131,10 +1131,10 @@ wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL #' #' @param inputs Input raster files. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1168,10 +1168,10 @@ wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=NUL #' @param output2 Output significance (p-value) raster file. #' @param filter Size of the filter kernel. #' @param stat Correlation type; one of 'pearson' (default) and 'spearman'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1212,10 +1212,10 @@ wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1 #' @param standardize Optional flag indicating whether to standardize the residuals map. #' @param scattergram Optional flag indicating whether to output a scattergram. #' @param num_samples Number of samples used to create scattergram. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1256,10 +1256,10 @@ wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, sta #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1287,10 +1287,10 @@ wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=NULL, compres #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1318,10 +1318,10 @@ wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=NULL, comp #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1349,10 +1349,10 @@ wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=NULL, co #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1380,10 +1380,10 @@ wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=NULL, co #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1412,10 +1412,10 @@ wbt_increment <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1444,10 +1444,10 @@ wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=N #' #' @param inputs Name of the input PCA component images. #' @param report Name of the PCA report file (*.html). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1475,10 +1475,10 @@ wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, ve #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1507,10 +1507,10 @@ wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' @param input1 Input classification raster file. #' @param input2 Input reference raster file. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1540,10 +1540,10 @@ wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, #' @param input Input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1576,10 +1576,10 @@ wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, #' @param input2 Input raster file or constant value. #' @param output Output raster file. #' @param incl_equals Perform a less-than-or-equal-to operation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1612,10 +1612,10 @@ wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, ve #' @param input Input vector file. #' @param field Input field name in attribute table. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1643,10 +1643,10 @@ wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=N #' @description Lists the unique values contained in a field within a vector's attribute table. #' #' @param input Input vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1673,10 +1673,10 @@ wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1704,10 +1704,10 @@ wbt_ln <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=N #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1735,10 +1735,10 @@ wbt_log10 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raster #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1767,10 +1767,10 @@ wbt_log2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1800,10 +1800,10 @@ wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1833,10 +1833,10 @@ wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1866,10 +1866,10 @@ wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compr #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1898,10 +1898,10 @@ wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1930,10 +1930,10 @@ wbt_negate <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1964,10 +1964,10 @@ wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, #' @param input2 Second input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2000,10 +2000,10 @@ wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, w #' @param input1 Name of the first input raster image file. #' @param input2 Name of the second input raster image file. #' @param output Name of the output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2033,10 +2033,10 @@ wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=NU #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2067,10 +2067,10 @@ wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compre #' @param output Output HTML report file. #' @param num_comp Number of component images to output; <= to num. input images. #' @param standardized Perform standardized PCA?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2105,10 +2105,10 @@ wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, stan #' @param input Input raster file. #' @param output Output raster file. #' @param num_quantiles Number of quantiles. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2139,10 +2139,10 @@ wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode= #' #' @param base Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2171,10 +2171,10 @@ wbt_random_field <- function(base, output, wd=NULL, verbose_mode=NULL, compress_ #' @param base Input raster file. #' @param output Output raster file. #' @param num_samples Number of samples. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2205,10 +2205,10 @@ wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_m #' #' @param statement Statement e.g. cos("raster1") * 35.0 + "raster2". This statement must be a valid Rust statement. #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2238,10 +2238,10 @@ wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=NU #' #' @param input Input raster file. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2268,10 +2268,10 @@ wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=NULL, comp #' @description Measures a rasters min, max, average, standard deviation, num. non-nodata cells, and total. #' #' @param input Input raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2298,10 +2298,10 @@ wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=NULL, compress #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2333,10 +2333,10 @@ wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' @param out_max_val New maximum value in output image. #' @param clip_min Optional lower tail clip value. #' @param clip_max Optional upper tail clip value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2372,10 +2372,10 @@ wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, cli #' #' @param input Input raster file. #' @param base Input base raster file used for comparison. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2403,10 +2403,10 @@ wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=NULL, #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2434,10 +2434,10 @@ wbt_round <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raster #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2465,10 +2465,10 @@ wbt_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2496,10 +2496,10 @@ wbt_sinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2527,10 +2527,10 @@ wbt_square <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2559,10 +2559,10 @@ wbt_square_root <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2591,10 +2591,10 @@ wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2622,10 +2622,10 @@ wbt_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2653,10 +2653,10 @@ wbt_tanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2684,10 +2684,10 @@ wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2716,10 +2716,10 @@ wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' @param input Input raster file. #' @param output Output raster file. #' @param order Polynomial order (1 to 10). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2753,10 +2753,10 @@ wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=NULL #' @param output Output raster file. #' @param order Polynomial order (1 to 10). #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2790,10 +2790,10 @@ wbt_trend_surface_vector_points <- function(input, field, output, cell_size, ord #' @param input Input raster file. #' @param output Output raster file. #' @param num_decimals Number of decimals left after truncation (default is zero). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2826,10 +2826,10 @@ wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode #' @param output Output file. #' @param range The field's range, in xy-units, related to the extent of spatial autocorrelation. #' @param iterations The number of iterations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2863,10 +2863,10 @@ wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, w #' @param input2 Second input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2900,10 +2900,10 @@ wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd= #' @param input2 Second input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2936,10 +2936,10 @@ wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NU #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2968,10 +2968,10 @@ wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -3002,10 +3002,10 @@ wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ras #' @param output Output raster file. #' @param stat Statistic to extract, including 'mean', 'median', 'minimum', 'maximum', 'range', 'standard deviation', and 'total'. #' @param out_table Output HTML Table file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' diff --git a/PY2R/scripts/precision_agriculture.R b/PY2R/scripts/precision_agriculture.R index bc7d03b5e..50c22d70f 100644 --- a/PY2R/scripts/precision_agriculture.R +++ b/PY2R/scripts/precision_agriculture.R @@ -10,10 +10,10 @@ #' @param min_yield Minimum yield value in output. #' @param max_yield Maximum yield value in output. #' @param mean_tonnage Use this optional parameter to force the output to have a certain overall average tonnage. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -59,10 +59,10 @@ wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, out #' @param output_points Name of the output points shapefile. #' @param max_change_in_heading Max change in heading. #' @param ignore_zeros Ignore zero-valued yield points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -101,10 +101,10 @@ wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, outpu #' @param dist Average distance between passes, in meters. #' @param max_change_in_heading Max change in heading. #' @param flag_edges Don't remove edge points, just flag them in the attribute table?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -147,10 +147,10 @@ wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in #' @param z_score_threshold Z-score threshold value (default=2.5). #' @param min_yield Minimum yield value in output. #' @param max_yield Maximum yield value in output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -195,10 +195,10 @@ wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096 #' @param output Name of the output polygon shapefile. #' @param width Pass swath width (m). #' @param max_change_in_heading Max change in heading. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -238,10 +238,10 @@ wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_chang #' @param radius Optional search radius, in metres. Only specify this value if you want to calculate locally normalized yield. #' @param min_yield Minimum yield value in output. #' @param max_yield Maximum yield value in output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' diff --git a/PY2R/scripts/stream_network_analysis.R b/PY2R/scripts/stream_network_analysis.R index b2823354f..914f94744 100644 --- a/PY2R/scripts/stream_network_analysis.R +++ b/PY2R/scripts/stream_network_analysis.R @@ -7,10 +7,10 @@ #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -47,10 +47,10 @@ wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, ze #' @param output Output raster file. #' @param threshold Threshold in flow accumulation values for channelization. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -85,10 +85,10 @@ wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=F #' @param variant Options include 'LQ' (lower quartile), 'JandR' (Johnston and Rosenfeld), and 'PandD' (Peucker and Douglas); default is 'LQ'. #' @param line_thin Optional flag indicating whether post-processing line-thinning should be performed. #' @param filter Optional argument (only used when variant='lq') providing the filter size, in grid cells, used for lq-filtering (default is 5). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -128,10 +128,10 @@ wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filte #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -169,10 +169,10 @@ wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -210,10 +210,10 @@ wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_b #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -251,10 +251,10 @@ wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -292,10 +292,10 @@ wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, z #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -333,10 +333,10 @@ wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr= #' @param dem Input raster DEM file. #' @param output Output HTML file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -372,10 +372,10 @@ wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd= #' @param dem Input raster DEM file. #' @param output Output HTML file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -410,10 +410,10 @@ wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr #' @param d8_pntr Input raster D8 pointer file. #' @param output Output vector file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -448,10 +448,10 @@ wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FAL #' @param output Output raster file. #' @param nodata Use NoData value for background?. #' @param feature_id Use feature number as output value?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -489,10 +489,10 @@ wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id #' @param output Output raster file. #' @param min_length Minimum tributary length (in map units) used for network pruning. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -526,10 +526,10 @@ wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_ #' @param input Name of the input lines vector file. #' @param output Name of the output lines vector file. #' @param dist Snap distance, in xy units (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -563,10 +563,10 @@ wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, v #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -604,10 +604,10 @@ wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALS #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -645,10 +645,10 @@ wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -686,10 +686,10 @@ wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -727,10 +727,10 @@ wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -769,10 +769,10 @@ wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zer #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -812,10 +812,10 @@ wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -854,10 +854,10 @@ wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -895,10 +895,10 @@ wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FAL #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -936,10 +936,10 @@ wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param output Name of the output lines shapefile. #' @param cutting_height Maximum ridge-cutting height (z units). #' @param snap Snap distance, in xy units (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' diff --git a/PY2R/scripts/terrain_analysis.R b/PY2R/scripts/terrain_analysis.R index 8ac76499f..f08fb929a 100644 --- a/PY2R/scripts/terrain_analysis.R +++ b/PY2R/scripts/terrain_analysis.R @@ -6,10 +6,10 @@ #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -44,10 +44,10 @@ wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=N #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -81,10 +81,10 @@ wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=NULL, co #' @param output Name of the output lines shapefile. #' @param length Maximum segment length (m). #' @param dist Search distance, in grid cells, used in visibility analysis. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -120,10 +120,10 @@ wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, v #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param filter Size of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -156,10 +156,10 @@ wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, #' @param output Name of the output vector lines file. #' @param threshold Threshold value (0 - infinity but typcially 1 to 5 works well). #' @param min_length Minimum line length, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -194,10 +194,10 @@ wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=N #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param filter Size of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -234,10 +234,10 @@ wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, ver #' @param interval Contour interval. #' @param base Base contour height. #' @param smooth Smoothing filter size (in num. points), e.g. 3, 5, 7, 9, 11. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -287,10 +287,10 @@ wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max #' @param base Base contour height. #' @param smooth Smoothing filter size (in num. points), e.g. 3, 5, 7, 9, 11. #' @param tolerance Tolerance factor, in degrees (0-45); determines generalization level. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -332,10 +332,10 @@ wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smo #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -373,10 +373,10 @@ wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose #' @param mean_plane_dist Distance to void edge at which the mean-plane value is used as an offset, measured in grid cells. #' @param edge_treatment How should void-edge cells be treated? Options include 'use DEM' (default), 'use Fill', 'average'. #' @param weight_value Weight value used for IDW interpolation (default is 2.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -416,10 +416,10 @@ wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_tre #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -455,10 +455,10 @@ wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -494,10 +494,10 @@ wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -533,10 +533,10 @@ wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NUL #' @param output Output raster file. #' @param azimuth Wind azimuth in degrees. #' @param max_dist Optional maximum search distance (unspecified if none; in xy units). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -572,10 +572,10 @@ wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=N #' @param output Output raster file. #' @param drop Vertical drop value (default is 2.0). #' @param out_type Output type, options include 'tangent', 'degrees', 'radians', 'distance' (default is 'tangent'). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -612,10 +612,10 @@ wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NU #' @param filter Size of the filter kernel. #' @param norm_diff Maximum difference in normal vectors, in degrees. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -652,10 +652,10 @@ wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -686,10 +686,10 @@ wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=NULL, compress #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -726,10 +726,10 @@ wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits= #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -758,10 +758,10 @@ wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=NULL #' @param dem Input raster DEM file. #' @param watersheds Input raster watersheds file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -799,10 +799,10 @@ wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=N #' @param max_increment Maximum upwards increment between neighbouring cells on an embankment (in elevation units). #' @param spillout_slope Spillout slope (in degrees). #' @param remove_embankments Optional flag indicating whether to output a DEM with embankments removed (true) or an embankment raster map (false). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -858,10 +858,10 @@ wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_r #' @param azimuth Wind azimuth, in degrees. #' @param max_dist Optional maximum search distance. Minimum value is 5 x cell size. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -903,10 +903,10 @@ wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", #' @param num_iter Number of iterations. #' @param max_diff Maximum allowable absolute elevation change (optional). #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -951,10 +951,10 @@ wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=1 #' @param output Output raster file. #' @param azimuth Wind azimuth in degrees in degrees. #' @param hgt_inc Height increment value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -991,10 +991,10 @@ wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, #' @param filter Filter size (cells). #' @param weight IDW weight value. #' @param no_edges Optional flag indicating whether to exclude NoData cells in edge regions. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1032,10 +1032,10 @@ wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param line_thin Optional flag indicating whether post-processing line-thinning should be performed. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1068,10 +1068,10 @@ wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=N #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1113,10 +1113,10 @@ wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL #' @param num_steps Number of steps. #' @param lsp Output land-surface parameter; one of 'AnisotropyLTP', 'Aspect', 'DiffMeanElev', 'Eastness', 'Elevation', 'Hillshade', 'MeanCurvature', 'Northness', 'PlanCurvature', 'ProfileCurvature', 'Ruggedness', 'Slope', 'TanCurvature', 'TotalCurvature'. #' @param z_factor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1166,10 +1166,10 @@ wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, p #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1209,10 +1209,10 @@ wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL #' @param skip Distance (in cells) to begin calculating lines-of-sight. #' @param forms Classify geomorphons into 10 common land morphologies, else output ternary pattern. #' @param residuals Convert elevation to residuals of a linear model. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1261,10 +1261,10 @@ wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip #' @param azimuth Illumination source azimuth in degrees. #' @param altitude Illumination source altitude in degrees. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1303,10 +1303,10 @@ wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NUL #' @param output Output raster file. #' @param azimuth Azimuth, in degrees. #' @param max_dist Optional maximum search distance (unspecified if none; in xy units). Minimum value is 5 x cell size. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1342,10 +1342,10 @@ wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1380,10 +1380,10 @@ wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, #' @param inputs Input DEM files. #' @param watershed Input watershed files (optional). #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1422,10 +1422,10 @@ wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, ve #' @param reverse Optional flag indicating whether to use reverse the palette. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param full_mode Optional flag indicating whether to use full 360-degrees of illumination sources. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1482,10 +1482,10 @@ wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_ #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1527,10 +1527,10 @@ wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale= #' @param dem Name of the input DEM raster file. #' @param output Name of the output raster file. #' @param filter Edge length of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1563,10 +1563,10 @@ wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbo #' @param output Output raster file. #' @param max_slope Maximum inter-cell absolute slope. #' @param min_size Minimum feature size, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1604,10 +1604,10 @@ wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1647,10 +1647,10 @@ wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1687,10 +1687,10 @@ wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param log Optional flag to request the output be log-transformed. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1725,10 +1725,10 @@ wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode= #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1762,10 +1762,10 @@ wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1797,10 +1797,10 @@ wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NUL #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1838,10 +1838,10 @@ wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1875,10 +1875,10 @@ wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_ #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1908,10 +1908,10 @@ wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1947,10 +1947,10 @@ wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1984,10 +1984,10 @@ wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2017,10 +2017,10 @@ wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NUL #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2057,10 +2057,10 @@ wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' @param altitude Illumination source altitude in degrees. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param full_mode Optional flag indicating whether to use full 360-degrees of illumination sources. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2105,10 +2105,10 @@ wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=N #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). #' @param log Display output values using a log-scale. #' @param standardize Should each scale be standardized to z-scores?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2166,10 +2166,10 @@ wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2217,10 +2217,10 @@ wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_dig #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2260,10 +2260,10 @@ wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_sca #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2304,10 +2304,10 @@ wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, m #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2353,10 +2353,10 @@ wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2401,10 +2401,10 @@ wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_sc #' @param hillshade Input optional hillshade raster file. Note: a multi-directional (360-degree option) hillshade tends to work best in this application. #' @param output Output raster file. #' @param lightness Image lightness value (default is 1.2). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2440,10 +2440,10 @@ wbt_multiscale_topographic_position_image <- function(local, meso, broad, output #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2471,10 +2471,10 @@ wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2504,10 +2504,10 @@ wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, #' @param pos_output Name of the positive openness output raster file. #' @param neg_output Name of the negative openness output raster file. #' @param dist Search distance, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2543,10 +2543,10 @@ wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbos #' @param prof Profile curvature threshold value (default is 0.1). #' @param plan Plan curvature threshold value (default is 0.0). #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2588,10 +2588,10 @@ wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0. #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2627,10 +2627,10 @@ wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, v #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2665,10 +2665,10 @@ wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' @param lines Input vector line file. #' @param surface Input raster surface file. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2699,10 +2699,10 @@ wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=NULL, comp #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2738,10 +2738,10 @@ wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' @param output Output raster file. #' @param azimuth Illumination source azimuth. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2777,10 +2777,10 @@ wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2816,10 +2816,10 @@ wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=1 #' @param output Output raster file. #' @param filter Filter size (cells). #' @param slope Slope threshold value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2855,10 +2855,10 @@ wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, w #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2894,10 +2894,10 @@ wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, ver #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2931,10 +2931,10 @@ wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2965,10 +2965,10 @@ wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=NULL, compre #' @param output Output raster file. #' @param sca_exponent SCA exponent value. #' @param slope_exponent Slope exponent value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3011,10 +3011,10 @@ wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, s #' @param height Image height, in pixels. #' @param delay GIF time delay in milliseconds. #' @param label Label text (leave blank for none). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3071,10 +3071,10 @@ wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", da #' @param date Date in format DD/MM/YYYY. #' @param time Time in format HH::MM, e.g. 03:15AM or 14:30. #' @param location Location, defined as Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3118,10 +3118,10 @@ wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="2 #' @param dem Name of the input raster DEM file. #' @param output Name of the output raster image file. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3154,10 +3154,10 @@ wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=NULL #' @param output Output raster file. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param units Units of output raster; options include 'degrees', 'radians', 'percent'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3194,10 +3194,10 @@ wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbo #' @param bin_size Aspect bin size, in degrees. #' @param min_slope Minimum slope, in degrees. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3235,10 +3235,10 @@ wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, #' @param inputs Input DEM files. #' @param watershed Input watershed files (optional). #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3272,10 +3272,10 @@ wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param dev_threshold DEVmax Threshold. #' @param scale_threshold DEVmax scale threshold. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3313,10 +3313,10 @@ wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_thre #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param filter Size of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3350,10 +3350,10 @@ wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, ve #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3392,10 +3392,10 @@ wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx #' @param slope Input raster slope file. #' @param output Output raster file. #' @param exponent SCA exponent value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3427,10 +3427,10 @@ wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, ve #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3460,10 +3460,10 @@ wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=NULL, comp #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3506,10 +3506,10 @@ wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NU #' @param end_day End day of the year (1-365). #' @param start_time Starting hour to track shadows (e.g. 5, 5:00, 05:00:00). Assumes 24-hour time: HH:MM:SS. 'sunrise' is also a valid time. #' @param end_time Ending hour to track shadows (e.g. 21, 21:00, 21:00:00). Assumes 24-hour time: HH:MM:SS. 'sunset' is also a valid time. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3570,10 +3570,10 @@ wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_d #' @param attenuation Attenuation parameter. Range is 0-4. Zero means no attenuation. #' @param ambient_light Ambient light parameter. Range is 0.0-0.7. Zero means no ambient light. #' @param z_factor Elevation multiplier, or a vertical exageration. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3640,10 +3640,10 @@ wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=3 #' @param delay GIF time delay in milliseconds. #' @param label Label text (leave blank for none). #' @param dev_max Do you want to use DEVmax instead of DEV for measuring local topographic position?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3697,10 +3697,10 @@ wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd" #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3736,10 +3736,10 @@ wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, v #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3775,10 +3775,10 @@ wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbo #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3814,10 +3814,10 @@ wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, w #' @param stations Input viewing station vector file. #' @param output Output raster file. #' @param height Viewing station height, in z units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3851,10 +3851,10 @@ wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mod #' @param output Output raster file. #' @param height Viewing station height, in z units. #' @param res_factor The resolution factor determines the density of measured viewsheds. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3889,10 +3889,10 @@ wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, #' @param sca Input raster specific contributing area (SCA) file. #' @param slope Input raster slope file (in degrees). #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' diff --git a/PY2R/scripts/whitebox_utilities.R b/PY2R/scripts/whitebox_utilities.R index 5dd65f08a..9bcd063b4 100644 --- a/PY2R/scripts/whitebox_utilities.R +++ b/PY2R/scripts/whitebox_utilities.R @@ -3,10 +3,10 @@ #' @description Use to install a Whitebox extension product. #' #' @param install_extension Name of the extension product to install. Options include: 'General Toolset Extension', 'DEM & Spatial Hydrology Extension', 'Lidar & Remote Sensing Extension', and 'Agriculture Extension'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords WhiteboxUtilities #' @@ -34,10 +34,10 @@ wbt_install_wb_extension <- function(install_extension="General Toolset Extensio #' @description Opens the Whitebox Runner application. #' #' @param clear_app_state Clear the application state memory?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords WhiteboxUtilities #' diff --git a/R/data_tools.R b/R/data_tools.R index 8c3cec1f7..9c3a0bca8 100644 --- a/R/data_tools.R +++ b/R/data_tools.R @@ -3,10 +3,10 @@ #' @description Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates. #' #' @param input Input vector Points file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -33,10 +33,10 @@ wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=NULL #' #' @param input Input vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -64,10 +64,10 @@ wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compress #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -95,10 +95,10 @@ wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=NULL #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -129,10 +129,10 @@ wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=NULL, #' @param xfield X field number (e.g. 0 for first field). #' @param yfield Y field number (e.g. 1 for second field). #' @param epsg EPSG projection (e.g. 2958). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -170,10 +170,10 @@ wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NUL #' @param input Input vector file. #' @param output Output csv file. #' @param headers Export field names as file header?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -205,10 +205,10 @@ wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbos #' @param input Name of the input lines vector file. #' @param output Name of the output lines vector file. #' @param dist Snap distance, in xy units (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -242,10 +242,10 @@ wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode= #' @param input2 Input foreign vector file (i.e. source of data to be imported). #' @param fkey Foreign key field. #' @param import_field Imported field (all fields will be imported if not specified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -278,10 +278,10 @@ wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NU #' #' @param input Input vector line file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -312,10 +312,10 @@ wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=NULL, com #' @param csv Input CSV file (i.e. source of data to be imported). #' @param fkey Foreign key field. #' @param import_field Imported field (all fields will be imported if not specified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -348,10 +348,10 @@ wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, #' #' @param inputs Input vector files. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -379,10 +379,10 @@ wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=NULL, compre #' #' @param input Input raster file. #' @param new_value New NoData value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -413,10 +413,10 @@ wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbo #' @param input Input vector line or polygon file. #' @param output Output vector line or polygon file. #' @param exclude_holes Exclude hole parts from the feature splitting? (holes will continue to belong to their features in output.). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -450,10 +450,10 @@ wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd= #' @param value Constant value to fill raster with; either 'nodata' or numeric value. #' @param data_type Output raster data type; options include 'double' (64-bit), 'float' (32-bit), and 'integer' (signed 16-bit) (default is 'float'). #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -490,10 +490,10 @@ wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="fl #' #' @param input Input vector polygon file. #' @param output Output vector lines file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -520,10 +520,10 @@ wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=NULL, com #' @description Prints the tags within a GeoTIFF. #' #' @param input Input GeoTIFF file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -550,10 +550,10 @@ wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=NULL, compress_ #' #' @param input Input raster lines file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -581,10 +581,10 @@ wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=NULL #' #' @param input Input raster file. #' @param output Output vector points file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -612,10 +612,10 @@ wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=NUL #' #' @param input Input raster file. #' @param output Output vector polygons file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -642,10 +642,10 @@ wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=N #' @description Reinitializes a vector's attribute table deleting all fields but the feature ID (FID). #' #' @param input Input vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -672,10 +672,10 @@ wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=NULL, #' #' @param input Input vector polygon file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -705,10 +705,10 @@ wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=NULL, #' @param output Name of the output raster file. #' @param threshold Maximum size of removed holes, in grid cells. Blank for no threshold, i.e. remove all holes. #' @param use_diagonals Use diagonal neighbours during clumping operation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -743,10 +743,10 @@ wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diag #' @param input Input raster file. #' @param output Output raster file. #' @param back_value Background value to set to nodata. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -778,10 +778,10 @@ wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose #' @param input Input vector line or polygon file. #' @param field Grouping ID field name in attribute table. #' @param output Output vector line or polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -816,10 +816,10 @@ wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, ve #' @param nodata Background value to set to NoData. Without this flag, it will be set to 0.0. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -864,10 +864,10 @@ wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, #' @param nodata Background value to set to NoData. Without this flag, it will be set to 0.0. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' @@ -914,10 +914,10 @@ wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last #' @param nodata Background value to set to NoData. Without this flag, it will be set to 0.0. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords DataTools #' diff --git a/R/gis_analysis.R b/R/gis_analysis.R index 26e68c95f..552b11101 100644 --- a/R/gis_analysis.R +++ b/R/gis_analysis.R @@ -6,10 +6,10 @@ #' @param output Output raster file. #' @param agg_factor Aggregation factor, in pixels. #' @param type Statistic used to fill output pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -47,10 +47,10 @@ wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NU #' @param output Output raster file. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -92,10 +92,10 @@ wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' @param output Output raster file. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -134,10 +134,10 @@ wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' @param input Input raster file. #' @param output Output raster file. #' @param text_output Optional text output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -168,10 +168,10 @@ wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode #' #' @param input Input vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -201,10 +201,10 @@ wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compr #' @param output Output raster file. #' @param diag Flag indicating whether diagonal connections should be considered. #' @param zero_back Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -241,10 +241,10 @@ wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbos #' @param use_z Use the 'z' dimension of the Shapefile's geometry instead of an attribute field?. #' @param output Output vector polygon file. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -283,10 +283,10 @@ wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max #' @param output Output vector polygon file. #' @param width The grid cell width. #' @param orientation Grid Orientation, 'horizontal' or 'vertical'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -321,10 +321,10 @@ wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation=" #' @param gradient Slope gradient in degrees (-85.0 to 85.0). #' @param aspect Aspect (direction) in degrees clockwise from north (0.0-360.0). #' @param constant Constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -365,10 +365,10 @@ wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant= #' @param height The grid cell height. #' @param xorig The grid origin x-coordinate. #' @param yorig The grid origin y-coordinate. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -406,10 +406,10 @@ wbt_create_rectangular_vector_grid <- function(input, output, width, height, xor #' @param field Dissolve field attribute (optional). #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -444,10 +444,10 @@ wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_m #' @param input Input vector file. #' @param output Output vector points file. #' @param tolerance The distance tolerance for points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -478,10 +478,10 @@ wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, v #' @param output Output vector polyline file. #' @param dist The distance to extend. #' @param extend Extend direction, 'both ends' (default), 'line start', 'line end'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -513,10 +513,10 @@ wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd= #' #' @param input Input vector lines or polygon file. #' @param output Output vector points file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -545,10 +545,10 @@ wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=NULL, compres #' @param inputs Input raster files. #' @param points Input vector points file. #' @param out_text Output point values as text? Otherwise, the only output is to to the points file's attribute table. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -581,10 +581,10 @@ wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, #' @param output Output raster file. #' @param threshold Remove features with fewer grid cells than this threshold value. #' @param background Background value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -617,10 +617,10 @@ wbt_filter_raster_features_by_area <- function(input, output, threshold, backgro #' @param input Input raster file. #' @param output Output vector points file. #' @param out_type Output type; one of 'area' (default) and 'volume'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -656,10 +656,10 @@ wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", #' @param kernel Kernel type; one of 'uniform', 'triangular', 'epanechnikov', 'quartic', 'triweight', 'tricube', 'gaussian', 'cosine', 'logistic', 'sigmoid', 'silverman'. #' @param cell_size Optionally specified cell size of output raster, in metres. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -709,10 +709,10 @@ wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel= #' @param min_points Minimum number of points. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -759,10 +759,10 @@ wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, #' #' @param input Input raster or vector file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -790,10 +790,10 @@ wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=NULL, compr #' #' @param input Input vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -823,10 +823,10 @@ wbt_medoid <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' @param output Output vector polygon file. #' @param criterion Minimization criterion; options include 'area' (default), 'length', 'width', and 'perimeter'. #' @param features Find the minimum bounding rectangles around each individual vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -861,10 +861,10 @@ wbt_minimum_bounding_box <- function(input, output, criterion="area", features=T #' @param input Input vector file. #' @param output Output vector polygon file. #' @param features Find the minimum bounding circle around each individual vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -896,10 +896,10 @@ wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, v #' @param input Input vector file. #' @param output Output vector polygon file. #' @param features Find the minimum bounding envelop around each individual vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -931,10 +931,10 @@ wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, #' @param input Input vector file. #' @param output Output vector polygon file. #' @param features Find the hulls around each vector feature. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -970,10 +970,10 @@ wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbo #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param clip Clip the data to the convex hull of the points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1021,10 +1021,10 @@ wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param max_dist Maximum search distance (optional). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1064,10 +1064,10 @@ wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, ce #' @description Calculates the area of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1094,10 +1094,10 @@ wbt_polygon_area <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input vector polygons file. #' @param output Output vector polyline file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1124,10 +1124,10 @@ wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=NULL, com #' @description Calculates the perimeter of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1154,10 +1154,10 @@ wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=NULL, compress_ra #' #' @param input Input vector polygons file. #' @param output Output vector polyline file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1194,10 +1194,10 @@ wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=NULL, co #' @param weight Weight parameter used in basis function. #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1253,10 +1253,10 @@ wbt_radial_basis_function_interpolation <- function(input, field, output, use_z= #' @param out_text Would you like to output polygon areas to text?. #' @param units Area units; options include 'grid cells' and 'map units'. #' @param zero_back Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1296,10 +1296,10 @@ wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cell #' @param input Input raster file. #' @param output Output raster file. #' @param assign Which variable would you like to assign to grid cells? Options include 'column', 'row', 'x', and 'y'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1333,10 +1333,10 @@ wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, #' @param out_text Would you like to output polygon areas to text?. #' @param units Area units; options include 'grid cells' and 'map units'. #' @param zero_back Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1377,10 +1377,10 @@ wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid #' @param output Output raster file. #' @param reclass_vals Reclassification triplet values (new value; from value; to less than), e.g. '0.0;0.0;1.0;1.0;1.0;2.0'. #' @param assign_mode Optional Boolean flag indicating whether to operate in assign mode, reclass_vals values are interpreted as new value; old value pairs. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1415,10 +1415,10 @@ wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, #' @param interval Class interval size. #' @param start_val Optional starting value (default is input minimum value). #' @param end_val Optional ending value (default is input maximum value). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1456,10 +1456,10 @@ wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=N #' @param input Input raster file. #' @param reclass_file Input text file containing reclass ranges. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1489,10 +1489,10 @@ wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_ #' @param input Input vector POLYLINE or POLYGON file. #' @param output Output vector file. #' @param filter The filter size, any odd integer greater than or equal to 3; default is 3. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1524,10 +1524,10 @@ wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=NU #' @param input Name of the input lines shapefile. #' @param output Name of the output lines shapefile. #' @param length Maximum segment length (m). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1563,10 +1563,10 @@ wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_ #' @param resolution Output raster's grid resolution. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1610,10 +1610,10 @@ wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution= #' @param input Name of the input points shapefile. #' @param output Name of the output lines shapefile. #' @param duration Maximum duration, in seconds. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1646,10 +1646,10 @@ wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, #' @param output Output vector polygon file. #' @param width The grid cell width. #' @param orientation Grid Orientation, 'horizontal' or 'vertical'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' @@ -1681,10 +1681,10 @@ wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal #' #' @param input Input vector points file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysis #' diff --git a/R/gis_analysis_distance.R b/R/gis_analysis_distance.R index 6fbf71845..9fc730e51 100644 --- a/R/gis_analysis_distance.R +++ b/R/gis_analysis_distance.R @@ -6,10 +6,10 @@ #' @param output Output raster file. #' @param size Buffer size. #' @param gridcells Optional flag to indicate that the 'size' threshold should be measured in grid cells instead of the default map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -42,10 +42,10 @@ wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, ver #' @param source Input source raster file. #' @param backlink Input backlink raster file generated by the cost-distance tool. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -76,10 +76,10 @@ wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode= #' @param cost Input cost (friction) raster file. #' @param out_accum Output cost accumulation raster file. #' @param out_backlink Output backlink raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -111,10 +111,10 @@ wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, ve #' @param backlink Input backlink raster file generated by the cost-distance tool. #' @param output Output cost pathway raster file. #' @param zero_background Flag indicating whether zero values should be treated as a background. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -146,10 +146,10 @@ wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALS #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' @@ -177,10 +177,10 @@ wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=NULL, #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisDistanceTools #' diff --git a/R/gis_analysis_overlay.R b/R/gis_analysis_overlay.R index 3be465fff..2ab18b2e9 100644 --- a/R/gis_analysis_overlay.R +++ b/R/gis_analysis_overlay.R @@ -4,10 +4,10 @@ #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -36,10 +36,10 @@ wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, comp #' @param input Input vector file. #' @param clip Input clip polygon vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -70,10 +70,10 @@ wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=NULL, compress_r #' @param polygons Input vector polygons file. #' @param output Output raster file. #' @param maintain_dimensions Maintain input raster dimensions?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -106,10 +106,10 @@ wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensi #' @param inputs Input raster files. #' @param output Output raster file. #' @param value Search value (e.g. countif value = 5.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -139,10 +139,10 @@ wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=NULL, comp #' @param input Input vector file. #' @param overlay Input overlay vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -172,10 +172,10 @@ wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=NULL, c #' @param input Input vector file. #' @param erase Input erase polygon vector file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -205,10 +205,10 @@ wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=NULL, compress #' @param input Input raster file. #' @param polygons Input vector polygons file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -237,10 +237,10 @@ wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verb #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -270,10 +270,10 @@ wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, com #' @param overlay Input overlay vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -306,10 +306,10 @@ wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mod #' @param input1 Input vector polyline file. #' @param input2 Input vector polyline file. #' @param output Output vector point file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -338,10 +338,10 @@ wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -369,10 +369,10 @@ wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, comp #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -400,10 +400,10 @@ wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -432,10 +432,10 @@ wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress #' @param input Input vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -466,10 +466,10 @@ wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mo #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -497,10 +497,10 @@ wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -528,10 +528,10 @@ wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -560,10 +560,10 @@ wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, com #' @param inputs Input raster files. #' @param comparison Input comparison raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -593,10 +593,10 @@ wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mo #' @param inputs Input raster files. #' @param comparison Input comparison raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -626,10 +626,10 @@ wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbos #' @param inputs Input raster files. #' @param comparison Input comparison raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -659,10 +659,10 @@ wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_m #' @param inputs Input raster files. #' @param pos_input Input position raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -691,10 +691,10 @@ wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode= #' #' @param inputs Input vector polyline file. #' @param output Output vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -723,10 +723,10 @@ wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_ #' @param input Input vector line or polygon file. #' @param split Input vector polyline file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -755,10 +755,10 @@ wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=NUL #' #' @param inputs Input raster files. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -788,10 +788,10 @@ wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress #' @param overlay Input overlay vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -825,10 +825,10 @@ wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL #' @param overlay Input overlay vector file. #' @param output Output vector file. #' @param snap Snap tolerance. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -861,10 +861,10 @@ wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NU #' @param input1 Input raster file 1. #' @param input2 Input raster file 2; update layer. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -897,10 +897,10 @@ wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mod #' @param constraints Input constraints raster files. #' @param output Output raster file. #' @param scale_max Suitability scale maximum value (common values are 1.0, 100.0, and 255.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' @@ -939,10 +939,10 @@ wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraint #' @param inputs Input raster files. #' @param weights Weight values, contained in quotes and separated by commas or semicolons. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisOverlayTools #' diff --git a/R/gis_analysis_patch_shape.R b/R/gis_analysis_patch_shape.R index 01e55ec3c..84d7987b9 100644 --- a/R/gis_analysis_patch_shape.R +++ b/R/gis_analysis_patch_shape.R @@ -4,10 +4,10 @@ #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -34,10 +34,10 @@ wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=N #' @description Calculates the compactness ratio (A/P), a measure of shape complexity, for vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -65,10 +65,10 @@ wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_ra #' @param input Input raster file. #' @param output Output raster file. #' @param output_text flag indicating whether a text report should also be output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -98,10 +98,10 @@ wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbo #' @description Calculates the elongation ratio for vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -128,10 +128,10 @@ wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_ras #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -158,10 +158,10 @@ wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_m #' @description Calculates the proportion of the total area of a polygon's holes relative to the area of the polygon's hull. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -187,10 +187,10 @@ wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=NULL, compress_rast #' @description Calculates the linearity index for vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -217,10 +217,10 @@ wbt_linearity_index <- function(input, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -247,10 +247,10 @@ wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=NULL, comp #' @description Calculates the orientation of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -276,10 +276,10 @@ wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=NULL, compress_ra #' @description Calculates the perimeter-area ratio of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -307,10 +307,10 @@ wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress #' @param input Input raster file. #' @param output Output raster file. #' @param text_output Optional text output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -340,10 +340,10 @@ wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, ve #' @description Calculates the related circumscribing circle of vector polygons. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -369,10 +369,10 @@ wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=NULL, #' @description Calculates overall polygon shape complexity or irregularity. #' #' @param input Input vector polygon file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' @@ -399,10 +399,10 @@ wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=NULL, compre #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GISAnalysisPatchShapeTools #' diff --git a/R/hydro_analysis.R b/R/hydro_analysis.R index ef1712405..ae5ddbde5 100644 --- a/R/hydro_analysis.R +++ b/R/hydro_analysis.R @@ -4,10 +4,10 @@ #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -35,10 +35,10 @@ wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=NULL, #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -67,10 +67,10 @@ wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mo #' @param d8_pntr Input raster D8 pointer file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -105,10 +105,10 @@ wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=N #' @param max_length Optional maximum breach channel length (in grid cells; default is Inf). #' @param flat_increment Optional elevation increment applied to flat areas. #' @param fill_pits Optional flag indicating whether to fill single-cell pits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -153,10 +153,10 @@ wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, #' @param min_dist Optional flag indicating whether to minimize breach distances. #' @param flat_increment Optional elevation increment applied to flat areas. #' @param fill Optional flag indicating whether to fill any remaining unbreached depressions. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -197,10 +197,10 @@ wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -231,10 +231,10 @@ wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, #' @param roads Input vector roads file. #' @param output Output raster file. #' @param width Maximum road embankment width, in map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -272,10 +272,10 @@ wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, w #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param pntr Is the input raster a D8 flow pointer rather than a DEM?. #' @param esri_pntr Input D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -321,10 +321,10 @@ wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, #' @param efficiency Input efficiency raster file. #' @param absorption Input absorption raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -356,10 +356,10 @@ wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NU #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -395,10 +395,10 @@ wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=N #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param pntr Is the input raster a D-infinity flow pointer rather than a DEM?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -444,10 +444,10 @@ wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contri #' @param efficiency Input efficiency raster file. #' @param absorption Input absorption raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -478,10 +478,10 @@ wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -510,10 +510,10 @@ wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_ #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param zero_background Flag indicating whether the background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -546,10 +546,10 @@ wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbo #' @param streams Name of the input streams vector (optional). #' @param lakes Name of the input lakes vector (optional). #' @param output Name of the output raster image file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -585,10 +585,10 @@ wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, v #' @param streams Input raster streams file. #' @param output Output raster file. #' @param dinf Use the D-infinity flow algorithm instead of D8?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -623,10 +623,10 @@ wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, w #' @param weights Optional input weights raster file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -665,10 +665,10 @@ wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weig #' @param output Name of the output raster file. #' @param flow_type Flow algorithm type, one of 'd8', 'mfd', or 'dinf'. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -703,10 +703,10 @@ wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd= #' @param dem Input raster DEM file. #' @param streams Input raster streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -736,10 +736,10 @@ wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mo #' @param dem Input raster DEM file. #' @param streams Input raster streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -773,10 +773,10 @@ wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -819,10 +819,10 @@ wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributi #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -851,10 +851,10 @@ wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param dem Input raster DEM file. #' @param streams Input vector streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -886,10 +886,10 @@ wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, comp #' @param fix_flats Optional flag indicating whether flat areas should have a small gradient applied. #' @param flat_increment Optional elevation increment applied to flat areas. #' @param max_depth Optional maximum depression depth to fill. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -928,10 +928,10 @@ wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NUL #' @param output Output raster file. #' @param fix_flats Optional flag indicating whether flat areas should have a small gradient applied. #' @param flat_increment Optional elevation increment applied to flat areas. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -967,10 +967,10 @@ wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRU #' @param output Output raster file. #' @param fix_flats Optional flag indicating whether flat areas should have a small gradient applied. #' @param flat_increment Optional elevation increment applied to flat areas. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1004,10 +1004,10 @@ wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_ #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1035,10 +1035,10 @@ wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, c #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1067,10 +1067,10 @@ wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=NULL, comp #' @param d8_pntr Input D8 pointer raster file. #' @param streams Input raster streams file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1100,10 +1100,10 @@ wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mo #' @param dem Input raster DEM file. #' @param lakes Input lakes vector polygons file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1132,10 +1132,10 @@ wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=NULL, co #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1169,10 +1169,10 @@ wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1215,10 +1215,10 @@ wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accu #' @param d8_pntr Input D8 pointer raster file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1251,10 +1251,10 @@ wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verb #' @param streams Input raster streams file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1289,10 +1289,10 @@ wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, v #' @param output2 Name of the output upslope disconnected saturated area (UDSA) file. #' @param exponent Optional exponent parameter; default is 1.0. #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1332,10 +1332,10 @@ wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, thr #' @param out_area Output flooded area file. #' @param out_dam_height Output dam height file. #' @param damlength Maximum length of the dam. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1380,10 +1380,10 @@ wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NU #' @param dam_pts Input vector dam points file. #' @param output Output file. #' @param damlength Maximum length of the dam. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1415,10 +1415,10 @@ wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mo #' @param output Output raster file. #' @param size Target basin size, in grid cells. #' @param connections Output upstream-downstream flow connections among basins?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1452,10 +1452,10 @@ wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose #' @param streams Input raster streams file. #' @param output Output vector file. #' @param snap_dist Maximum snap distance in map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1486,10 +1486,10 @@ wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd #' @param dem Input raster DEM file. #' @param basins Input raster basins file. #' @param output Output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1519,10 +1519,10 @@ wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=NULL #' @param dem Name of the input DEM raster file. #' @param streams Name of the input stream channel raster file. #' @param output Name of the output vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1551,10 +1551,10 @@ wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, v #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1583,10 +1583,10 @@ wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=N #' @param dem Input DEM; it must be depressionless. #' @param values Name of the input values raster file. #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1620,10 +1620,10 @@ wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=NUL #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Optional flag to request the output be log-transformed. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1666,10 +1666,10 @@ wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contrib #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1703,10 +1703,10 @@ wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Log-transform the output values?. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1757,10 +1757,10 @@ wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributi #' @param threshold Optional convergence threshold parameter, in grid cells; default is infinity. #' @param log Log-transform the output values?. #' @param clip Optional flag to request clipping the display max by 1 percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1806,10 +1806,10 @@ wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contribu #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param height Wall height. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1849,10 +1849,10 @@ wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NU #' @param clip Optional flag to request clipping the display max by 1 percent. #' @param pntr Is the input raster a Rho8 flow pointer rather than a DEM?. #' @param esri_pntr Does the input Rho8 pointer use the ESRI style scheme?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1896,10 +1896,10 @@ wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contrib #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1932,10 +1932,10 @@ wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode #' @param output Name of the output vector lines file. #' @param min_length Minimum line length, in grid cells. #' @param radius Search radius for joining distant endnodes, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -1970,10 +1970,10 @@ wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL #' @param input Input raster DEM file. #' @param output Output raster file. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2006,10 +2006,10 @@ wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode #' @param flow_accum Input raster D8 flow accumulation file. #' @param output Output vector file. #' @param snap_dist Maximum snap distance in map units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2042,10 +2042,10 @@ wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NUL #' @param rmse The DEM's root-mean-square-error (RMSE), in z units. This determines error magnitude. #' @param range The error field's correlation length, in xy-units. #' @param iterations The number of iterations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2080,10 +2080,10 @@ wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterati #' @param streams Input raster streams file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2117,10 +2117,10 @@ wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param streams Input raster streams file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2155,10 +2155,10 @@ wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, ve #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2195,10 +2195,10 @@ wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=F #' @param pour_pts Input vector pour points (outlet) file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2230,10 +2230,10 @@ wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NUL #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' @@ -2263,10 +2263,10 @@ wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=NU #' @param pour_pts Input pour points (outlet) file. #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords HydrologicalAnalysis #' diff --git a/R/image_analysis.R b/R/image_analysis.R index e5f37393d..afae272f6 100644 --- a/R/image_analysis.R +++ b/R/image_analysis.R @@ -6,10 +6,10 @@ #' @param date2 Input raster files for the later date. #' @param magnitude Output vector magnitude raster file. #' @param direction Output vector Direction raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -41,10 +41,10 @@ wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NU #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -83,10 +83,10 @@ wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' @param output Output colour composite file. #' @param enhance Optional flag indicating whether a balance contrast enhancement is performed. #' @param zeros Optional flag to indicate if zeros are nodata values. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -126,10 +126,10 @@ wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, #' @param input Input raster file. #' @param output Output raster file. #' @param direction Direction of reflection; options include 'v' (vertical), 'h' (horizontal), and 'b' (both). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -165,10 +165,10 @@ wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose #' @param green Output green band file. Optionally specified if colour-composite not specified. #' @param blue Output blue band file. Optionally specified if colour-composite not specified. #' @param output Output colour-composite file. Only used if individual bands are not specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -217,10 +217,10 @@ wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' @param label2 Right image label (leave blank for none). #' @param output Name of the output HTML file (*.html). #' @param height Image height, in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -271,10 +271,10 @@ wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=F #' @param inputs Input multispectral image files. #' @param points Input vector points file. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -303,10 +303,10 @@ wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mod #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -334,10 +334,10 @@ wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=NULL, compre #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -366,10 +366,10 @@ wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=NULL, compres #' @param inputs Input raster files. #' @param output Output raster file. #' @param method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -405,10 +405,10 @@ wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=N #' @param output Output raster file. #' @param method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution). #' @param weight . -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -446,10 +446,10 @@ wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weig #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. #' @param correction Optional adjustment value (e.g. 1, or 0.16 for the optimal soil adjusted vegetation index, OSAVI). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -486,10 +486,10 @@ wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, co #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -524,10 +524,10 @@ wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' @param input Input raster file. #' @param output Output raster file. #' @param iterations Maximum number of iterations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -561,10 +561,10 @@ wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. #' @param base Optionally specified input base raster file. Not used when a cell size is specified. #' @param method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -606,10 +606,10 @@ wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", #' @param intensity Output intensity raster file. #' @param hue Output hue raster file. #' @param saturation Output saturation raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -652,10 +652,10 @@ wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' @param red Output red band file. #' @param green Output green band file. #' @param blue Output blue band file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -691,10 +691,10 @@ wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, w #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -725,10 +725,10 @@ wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=NULL, c #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param variant Optional variant value. Options include 'white' and 'black'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' @@ -767,10 +767,10 @@ wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant= #' @param input2 Input raster file associated with the second date. #' @param input3 Optional input raster file associated with the third date. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingTools #' diff --git a/R/image_analysis_classification.R b/R/image_analysis_classification.R index e0040119b..97289ebaa 100644 --- a/R/image_analysis_classification.R +++ b/R/image_analysis_classification.R @@ -6,10 +6,10 @@ #' @param polys Name of the input training site polygons shapefile. #' @param field Name of the attribute containing class name data. #' @param output Name of the output report file (*.html). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -41,10 +41,10 @@ wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, v #' @param output Name of the output raster file. #' @param min_size Minimum feature size, in grid cells. #' @param method Grouping method; one of 'longest' (default), 'largest', and 'nearest'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -80,10 +80,10 @@ wbt_generalize_classified_raster <- function(input, output, min_size=4, method=" #' @param similarity Names of the input similarity images. #' @param output Name of the output raster file. #' @param min_size Minimum feature size, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -118,10 +118,10 @@ wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4 #' @param threshold Distance threshold, in z-scores. #' @param steps Number of steps. #' @param min_area Minimum object area, in grid cells (1-8). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -161,10 +161,10 @@ wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_ #' @param field Name of the attribute containing class name data. #' @param output Name of the output raster file. #' @param threshold Distance threshold, in z-scores; blank for none. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' @@ -199,10 +199,10 @@ wbt_min_dist_classification <- function(inputs, polys, field, output, threshold= #' @param polys Name of the input training site polygons shapefile. #' @param field Name of the attribute containing class name data. #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsClassification #' diff --git a/R/image_analysis_enhancement.R b/R/image_analysis_enhancement.R index 7ebce27ef..ea555012c 100644 --- a/R/image_analysis_enhancement.R +++ b/R/image_analysis_enhancement.R @@ -5,10 +5,10 @@ #' @param input Input colour composite image file. #' @param output Output raster file. #' @param band_mean Band mean value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -43,10 +43,10 @@ wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd= #' @param focal_length Camera focal length, in millimeters. #' @param image_width Distance between photograph edges, in millimeters. #' @param n The 'n' parameter. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -86,10 +86,10 @@ wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_ #' @param output Output raster file. #' @param k Achromatic factor (k) ranges between 0 (no effect) and 1 (full saturation stretch), although typical values range from 0.3 to 0.7. #' @param clip Optional percent to clip the upper tail by during the stretch. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -124,10 +124,10 @@ wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd= #' @param input Input raster file. #' @param output Output raster file. #' @param gamma Gamma value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -159,10 +159,10 @@ wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode #' @param input Input raster file. #' @param output Output raster file. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -194,10 +194,10 @@ wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, #' @param input Input raster file. #' @param output Output raster file. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -229,10 +229,10 @@ wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, ve #' @param input Input raster file. #' @param histo_file Input reference probability distribution function (pdf) text file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -262,10 +262,10 @@ wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_m #' @param input1 Input raster file to modify. #' @param input2 Input reference raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -297,10 +297,10 @@ wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, v #' @param min_val Lower tail clip value. #' @param max_val Upper tail clip value. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -338,10 +338,10 @@ wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_to #' @param pan Input panchromatic band file. #' @param output Output colour composite file. #' @param method Options include 'brovey' (default) and 'ihs'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -387,10 +387,10 @@ wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue= #' @param clip Optional amount to clip the distribution tails by, in percent. #' @param tail Specified which tails to clip; options include 'upper', 'lower', and 'both' (default is 'both'). #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -429,10 +429,10 @@ wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both" #' @param output Name of the output raster image file. #' @param FUN Piecewise break-points e.g. '(50, 0.1); (150, 0.8); (255; 1.0). #' @param greytones Number of greytones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -469,10 +469,10 @@ wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024 #' @param cutoff Cutoff value between 0.0 and 0.95. #' @param gain Gain value. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' @@ -511,10 +511,10 @@ wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, #' @param output Output raster file. #' @param stdev Standard deviation clip value. #' @param num_tones Number of tones in the output image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsImageEnhancement #' diff --git a/R/image_analysis_filters.R b/R/image_analysis_filters.R index f7e4a2af4..8f6e8cac9 100644 --- a/R/image_analysis_filters.R +++ b/R/image_analysis_filters.R @@ -7,10 +7,10 @@ #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param threshold Difference from mean threshold, in standard deviations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -49,10 +49,10 @@ wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold #' @param output Output raster file. #' @param sigma_dist Standard deviation in distance in pixels. #' @param sigma_int Standard deviation in intensity in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -90,10 +90,10 @@ wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, #' @param low Low threshold, default = 0.05. #' @param high High threshold, default = 0.15. #' @param add_back Add the edge cells back to the input image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -135,10 +135,10 @@ wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0. #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -172,10 +172,10 @@ wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery= #' #' @param input Input boolean image. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -205,10 +205,10 @@ wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=NULL, comp #' @param output Output raster file. #' @param sigma1 Standard deviation distance in pixels. #' @param sigma2 Standard deviation distance in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -244,10 +244,10 @@ wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, w #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -283,10 +283,10 @@ wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' @param output Output raster file. #' @param filter Size of the filter kernel. #' @param threshold Maximum difference in values. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -320,10 +320,10 @@ wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, #' @param output Output raster file. #' @param direction Direction of reflection; options include 'n', 's', 'e', 'w', 'ne', 'se', 'nw', 'sw'. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -358,10 +358,10 @@ wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, v #' @param input Input raster file. #' @param output Output raster file. #' @param sigma Standard deviation distance in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -393,10 +393,10 @@ wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, v #' @param input Input raster file. #' @param output Output raster file. #' @param sigma Standard deviation distance in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -429,10 +429,10 @@ wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode #' @param output Output raster file. #' @param sigma_dist Standard deviation in distance in pixels. #' @param sigma_int Standard deviation in intensity in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -468,10 +468,10 @@ wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -508,10 +508,10 @@ wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -551,10 +551,10 @@ wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, s #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param k k-value in pixels; this is the number of nearest-valued neighbours to use. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -593,10 +593,10 @@ wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5 #' @param output Output raster file. #' @param variant Optional variant value. Options include 3x3(1), 3x3(2), 3x3(3), 3x3(4), 5x5(1), and 5x5(2) (default is 3x3(1)). #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -631,10 +631,10 @@ wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=N #' @param input Input raster file. #' @param output Output raster file. #' @param sigma Standard deviation in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -669,10 +669,10 @@ wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, #' @param filtery Size of the filter kernel in the y-direction. #' @param sigma Sigma value should be related to the standard deviation of the distribution of image speckle noise. #' @param m M-threshold value the minimum allowable number of pixels within the intensity range. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -715,10 +715,10 @@ wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10 #' @param variant Optional variant value. Options include 'v' (vertical), 'h' (horizontal), '45', and '135' (default is 'v'). #' @param absvals Optional flag indicating whether outputs should be absolute values. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -757,10 +757,10 @@ wbt_line_detection_filter <- function(input, output, variant="vertical", absvals #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -796,10 +796,10 @@ wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -835,10 +835,10 @@ wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -875,10 +875,10 @@ wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbos #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -917,10 +917,10 @@ wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits= #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -956,10 +956,10 @@ wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -996,10 +996,10 @@ wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1037,10 +1037,10 @@ wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_dig #' @param input Input raster file. #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1073,10 +1073,10 @@ wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NU #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1111,10 +1111,10 @@ wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' @param input Input raster file. #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1146,10 +1146,10 @@ wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_m #' @param input Input raster file. #' @param output Output raster file. #' @param clip Optional amount to clip the distribution tails by, in percent. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1182,10 +1182,10 @@ wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NUL #' @param output Output raster file. #' @param variant Optional variant value. Options include 3x3 and 5x5 (default is 3x3). #' @param clip Optional amount to clip the distribution tails by, in percent (default is 0.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1221,10 +1221,10 @@ wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, ve #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1260,10 +1260,10 @@ wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1300,10 +1300,10 @@ wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' @param sigma Standard deviation distance in pixels. #' @param amount A percentage and controls the magnitude of each overshoot. #' @param threshold Controls the minimal brightness change that will be sharpened. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' @@ -1343,10 +1343,10 @@ wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, thresho #' @param output Output raster file. #' @param center Kernel center cell; options include 'center', 'upper-left', 'upper-right', 'lower-left', 'lower-right'. #' @param normalize Normalize kernel weights? This can reduce edge effects and lessen the impact of data gaps (nodata) but is not suited when the kernel weights sum to zero. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords ImageProcessingToolsFilters #' diff --git a/R/lidar_analysis.R b/R/lidar_analysis.R index ff6d936ee..5a7865441 100644 --- a/R/lidar_analysis.R +++ b/R/lidar_analysis.R @@ -5,10 +5,10 @@ #' @param inputs Input LiDAR ASCII files (.csv). #' @param pattern Input field pattern. #' @param proj Well-known-text string or EPSG code describing projection. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -40,10 +40,10 @@ wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=N #' @param input Input LiDAR file. #' @param buildings Input vector polygons file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -79,10 +79,10 @@ wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, v #' @param linearity_threshold Linearity threshold (0-1). #' @param iterations Number of iterations. #' @param facade_threshold Facade threshold (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -136,10 +136,10 @@ wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1 #' @param resolution The size of the square area used to evaluate nearby points in the LiDAR data. #' @param criterion Criterion used to identify overlapping points; options are 'max scan angle', 'not min point source ID', 'not min time', 'multiple point source IDs'. #' @param filter Filter out points from overlapping flightlines? If false, overlaps will simply be classified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -177,10 +177,10 @@ wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion #' @param input Input LiDAR file. #' @param polygons Input vector polygons file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -213,10 +213,10 @@ wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_ #' @param clr_str Colour values, e.g. 2: (184, 167, 108); 5: #9ab86c. #' @param use_unique_clrs_for_buildings Use unique colours for each building?. #' @param radius Search distance used in neighbourhood search. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -263,10 +263,10 @@ wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending= #' @param first First return colour, e.g. (230,214,170), #e6d6aa, or 0xe6d6aa. #' @param intermediate Intermediate return colour, e.g. (230,214,170), #e6d6aa, or 0xe6d6aa. #' @param last Last return colour, e.g. (230,214,170), #e6d6aa, or 0xe6d6aa. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -316,10 +316,10 @@ wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_b #' @param input Input LiDAR file. #' @param polygons Input vector polygons file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -349,10 +349,10 @@ wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbo #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. #' @param statement Filter statement e.g. x < 5000.0 && y > 100.0 && is_late && !is_noise. This statement must be a valid Rust statement. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -386,10 +386,10 @@ wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -421,10 +421,10 @@ wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, v #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param threshold Scan angle threshold. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -453,10 +453,10 @@ wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verb #' #' @param input Input LiDAR file. #' @param output Output file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -485,10 +485,10 @@ wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode #' @param input Input LiDAR file. #' @param output Output file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -521,10 +521,10 @@ wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @param input Input LiDAR file (including extension). #' @param output Output lidar file (including extension). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -559,10 +559,10 @@ wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=NU #' @param max_search_radius Maximum search radius (m). #' @param max_height Maximum height (m). #' @param only_use_veg Only use veg. class points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -606,10 +606,10 @@ wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius= #' @description Converts one or more LAS files into ASCII text files. #' #' @param inputs Input LiDAR files. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -636,10 +636,10 @@ wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=NULL, compress_raster #' #' @param input Name of the input LAS files (leave blank to use all LAS files in WorkingDirectory. #' @param output Output LAZ file (including extension). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -668,10 +668,10 @@ wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compr #' @description Converts one or more LAS files into MultipointZ vector Shapefiles. When the input parameter is not specified, the tool grids all LAS files contained within the working directory. #' #' @param input Input LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -697,10 +697,10 @@ wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=NULL, c #' @description Converts one or more LAS files into a vector Shapefile of POINT ShapeType. #' #' @param input Input LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -729,10 +729,10 @@ wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=NULL, compress_ras #' @param outdir Output directory into which zlidar files are created. If unspecified, it is assumed to be the same as the inputs. #' @param compress Compression method, including 'brotli' and 'deflate'. #' @param level Compression level (1-9). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -770,10 +770,10 @@ wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level #' #' @param input Name of the input LAZ files (leave blank to use all LAZ files in WorkingDirectory. #' @param output Output LAS file (including extension). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -804,10 +804,10 @@ wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compr #' @param input Input LiDAR file. #' @param output Output file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -841,10 +841,10 @@ wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' @param input Input LiDAR file. #' @param output Output file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -880,10 +880,10 @@ wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' @param output Output LiDAR file. #' @param subset_class Subset point class value (must be 0-18; see LAS specifications). #' @param nonsubset_class Non-subset point class value (must be 0-18; see LAS specifications). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -917,10 +917,10 @@ wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsub #' @param in_lidar Input LiDAR file. #' @param in_image Input colour image file. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -958,10 +958,10 @@ wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mod #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1023,10 +1023,10 @@ wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smoot #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1072,10 +1072,10 @@ wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, #' @param input Name of the input LiDAR points. #' @param num_neighbours Number of neighbours used in search. #' @param radius Search distance used in neighbourhood search. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1113,10 +1113,10 @@ wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NUL #' @param cls Optional boolean flag indicating whether points outside the range should be retained in output but reclassified. #' @param inclassval Optional parameter specifying the class value assigned to points within the slice. #' @param outclassval Optional parameter specifying the class value assigned to points within the slice. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1166,10 +1166,10 @@ wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=F #' @param classify Classify points as ground (2) or off-ground (1). #' @param slope_norm Perform initial ground slope normalization?. #' @param height_above_ground Transform output to height above average ground elevation?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1220,10 +1220,10 @@ wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbo #' @param output Output vector polygon file. #' @param width The grid cell width. #' @param orientation Grid Orientation, 'horizontal' or 'vertical'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1258,10 +1258,10 @@ wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal" #' @param azimuth Illumination source azimuth in degrees. #' @param altitude Illumination source altitude in degrees. #' @param radius Search Radius. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1300,10 +1300,10 @@ wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, rad #' @param output Output HTML file (default name will be based on input file if unspecified). #' @param parameter Parameter; options are 'elevation' (default), 'intensity', 'scan angle', 'class', 'time'. #' @param clip Amount to clip distribution tails (in percent). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1345,10 +1345,10 @@ wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1405,10 +1405,10 @@ wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation #' @param density Flag indicating whether or not to calculate the average point density and nominal point spacing. #' @param vlr Flag indicating whether or not to print the variable length records (VLRs). #' @param geokeys Flag indicating whether or not to print the geokeys. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1445,10 +1445,10 @@ wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, #' #' @param inputs Input LiDAR files. #' @param output Output LiDAR file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1479,10 +1479,10 @@ wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_ #' @param output Output HTML file. #' @param class_accuracy Output classification accuracy raster file. #' @param resolution Output raster's grid resolution. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1522,10 +1522,10 @@ wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolu #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1582,10 +1582,10 @@ wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter=" #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1633,10 +1633,10 @@ wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolutio #' #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1672,10 +1672,10 @@ wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose #' @param z_range Flag indicating whether or not to output the elevation range raster. #' @param intensity_range Flag indicating whether or not to output the intensity range raster. #' @param predom_class Flag indicating whether or not to output the predominant classification raster. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1731,10 +1731,10 @@ wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pu #' @param max_slope Maximum planar slope. #' @param classify Classify points as ground (2) or off-ground (1). #' @param last_returns Only include last- and only-return points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1796,10 +1796,10 @@ wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_ #' @param func_type Radial basis function type; options are 'ThinPlateSpline' (default), 'PolyHarmonic', 'Gaussian', 'MultiQuadric', 'InverseMultiQuadric'. #' @param poly_order Polynomial order; options are 'none' (default), 'constant', 'affine'. #' @param weight Weight parameter used in basis function. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1860,10 +1860,10 @@ wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param include_z Include z-values in point comparison?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1898,10 +1898,10 @@ wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, #' @param elev_diff Max. elevation difference. #' @param use_median Optional flag indicating whether to use the difference from median elevation rather than mean. #' @param classify Classify points as ground (2) or off-ground (1). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -1951,10 +1951,10 @@ wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, #' @param norm_diff Maximum difference in normal vectors, in degrees. #' @param azimuth Illumination source azimuth, in degrees. #' @param altitude Illumination source altitude in degrees. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2022,10 +2022,10 @@ wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0 #' @param maxzdiff Maximum difference in elevation (z units) between neighbouring points of the same segment. #' @param classes Segments don't cross class boundaries. #' @param ground Classify the largest segment as ground points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2087,10 +2087,10 @@ wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_s #' @param norm_diff Maximum difference in normal vectors, in degrees. #' @param maxzdiff Maximum difference in elevation (z units) between neighbouring points of the same segment. #' @param classify Classify points as ground (2) or off-ground (1). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2133,10 +2133,10 @@ wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_ #' @param x_shift x-shift value, blank for none. #' @param y_shift y-shift value, blank for none. #' @param z_shift z-shift value, blank for none. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2179,10 +2179,10 @@ wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", w #' @param exclude_cls Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2230,10 +2230,10 @@ wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevat #' #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2264,10 +2264,10 @@ wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=NULL, co #' @param resolution The size of the square area used to evaluate nearby points in the LiDAR data. #' @param method Point selection method; options are 'first', 'last', 'lowest' (default), 'highest', 'nearest'. #' @param save_filtered Save filtered points to separate file?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2307,10 +2307,10 @@ wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_ #' @param resolution Output raster's grid resolution. #' @param density Max. point density (points / m^3). #' @param save_filtered Save filtered points to separate file?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2349,10 +2349,10 @@ wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, #' @param origin_x Origin point X coordinate for tile grid. #' @param origin_y Origin point Y coordinate for tile grid. #' @param min_points Minimum number of points contained in a tile for it to be saved. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2395,10 +2395,10 @@ wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, ori #' @param input Input LiDAR file. #' @param output Output vector polygon file. #' @param hull Identify the convex hull around points. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2436,10 +2436,10 @@ wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose #' @param minz Optional minimum elevation for inclusion in interpolation. #' @param maxz Optional maximum elevation for inclusion in interpolation. #' @param max_triangle_edge_length Optional maximum triangle edge length; triangles larger than this size will not be gridded. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2491,10 +2491,10 @@ wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", re #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param radius Search Radius. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2526,10 +2526,10 @@ wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbo #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. #' @param statement Modify statement e.g. x += 5000.0. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2563,10 +2563,10 @@ wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' @param input Input LiDAR file. #' @param output Output LiDAR file. #' @param radius Search Radius. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2598,10 +2598,10 @@ wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode= #' @param input Name of the input LiDAR file. #' @param output Name of the output LiDAR file. #' @param dtm Name of the input digital terrain model (DTM) raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2634,10 +2634,10 @@ wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=NULL, #' @param pt_src_id Add flightline information to the point source ID. #' @param user_data Add flightline information to the user data. #' @param rgb Add flightline information to the RGB colour data. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2678,10 +2678,10 @@ wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src #' @param indir Input LAS file source directory. #' @param outdir Output directory into which LAS files within the polygon are copied. #' @param polygons Input vector polygons file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2711,10 +2711,10 @@ wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbos #' @param input Name of the input LiDAR points. #' @param output Name of the output LiDAR points. #' @param criteria Sort criteria e.g. 'x 50.0, y 50.0, z'; criteria may include x, y, z, intensity, class, user_data, point_source_id, and scan_angle. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2749,10 +2749,10 @@ wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mod #' @param criterion Criterion on which to base the split of the input file. Options include 'num_pts, 'x', 'y', 'z', intensity, 'class', 'user_data', 'point_source_id', 'scan_angle', 'time'. #' @param interval Interval. #' @param min_pts Minimum number of points in an output file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' @@ -2788,10 +2788,10 @@ wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, #' #' @param inputs Input ZLidar files. #' @param outdir Output directory into which zlidar files are created. If unspecified, it is assumed to be the same as the inputs. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords LiDARTools #' diff --git a/R/machine_learning.R b/R/machine_learning.R index 76327f5b5..98a57e364 100644 --- a/R/machine_learning.R +++ b/R/machine_learning.R @@ -7,10 +7,10 @@ #' @param output Name of the output raster file. #' @param search_dist Search-distance parameter. #' @param min_points Minimum point density needed to define 'core' point in cluster. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -53,10 +53,10 @@ wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, mi #' @param class_change Minimum percent of cells changed between iterations before completion. #' @param initialize How to initialize cluster centres?. #' @param min_class_size Minimum class size, in pixels. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -106,10 +106,10 @@ wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_i #' @param k k-parameter, which determines the number of nearest neighbours used. #' @param clip Perform training data clipping to remove outlier pixels?. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -159,10 +159,10 @@ wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", #' @param k k-parameter, which determines the number of nearest neighbours used. #' @param weight Use distance weighting?. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -210,10 +210,10 @@ wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", out #' @param field Name of the attribute containing class data. #' @param output Name of the output raster file. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -256,10 +256,10 @@ wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize" #' @param merge_dist Cluster merger distance. #' @param max_iterations Maximum number of iterations. #' @param class_change Minimum percent of cells changed between iterations before completion. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -309,10 +309,10 @@ wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start #' @param min_samples_leaf The minimum number of samples required to be at a leaf node. #' @param min_samples_split The minimum number of samples required to split an internal node. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -365,10 +365,10 @@ wbt_random_forest_classification <- function(inputs, training, field, output=NUL #' @param min_samples_leaf The minimum number of samples required to be at a leaf node. #' @param min_samples_split The minimum number of samples required to split an internal node. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -419,10 +419,10 @@ wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n #' @param gamma Gamma parameter used in setting the RBF (Gaussian) kernel function. #' @param tolerance The tolerance parameter used in determining the stopping condition. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' @@ -476,10 +476,10 @@ wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", #' @param eps Epsilon in the epsilon-SVR model. #' @param gamma Gamma parameter used in setting the RBF (Gaussian) kernel function. #' @param test_proportion The proportion of the dataset to include in the test split; default is 0.2. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MachineLearning #' diff --git a/R/math_stat_analysis.R b/R/math_stat_analysis.R index a8fa5e57a..c1b2b9a5c 100644 --- a/R/math_stat_analysis.R +++ b/R/math_stat_analysis.R @@ -5,10 +5,10 @@ #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -38,10 +38,10 @@ wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -71,10 +71,10 @@ wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -103,10 +103,10 @@ wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_ #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -135,10 +135,10 @@ wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=NULL, compre #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -168,10 +168,10 @@ wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input Input raster file. #' @param features Feature definition (or class) raster. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -200,10 +200,10 @@ wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=NULL, compr #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -231,10 +231,10 @@ wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -262,10 +262,10 @@ wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -293,10 +293,10 @@ wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rast #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -324,10 +324,10 @@ wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -355,10 +355,10 @@ wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -387,10 +387,10 @@ wbt_artanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' @param input_y Input y raster file or constant value (rise). #' @param input_x Input x raster file or constant value (run). #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -419,10 +419,10 @@ wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=NULL, comp #' #' @param input Input vector file. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -456,10 +456,10 @@ wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode= #' @param radius Search Radius (in map units). #' @param min_points Minimum number of points. #' @param stat Correlation type; one of 'pearson' (default) and 'spearman'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -498,10 +498,10 @@ wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, fiel #' @param input Input vector file. #' @param field Input field name in attribute table. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -533,10 +533,10 @@ wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode= #' @param fieldy Input field name in attribute table for the y-axis. #' @param output Output HTML file (default name will be based on input file if unspecified). #' @param trendline Draw the trendline. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -569,10 +569,10 @@ wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=F #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -603,10 +603,10 @@ wbt_ceil <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' @param true Value where condition evaluates TRUE (input raster or constant value). #' @param false Value where condition evaluates FALSE (input raster or constant value). #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -652,10 +652,10 @@ wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, f #' @param temp_decay Annealing temperature decay proportion between `[0,1]`. Reduce temperature by this proportion each annealing cycle. #' @param cycle Number of iterations before decaying annealing temperature. #' @param average Weight the continuous objective funtion by the 1/N contributing strata. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -710,10 +710,10 @@ wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterati #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -741,10 +741,10 @@ wbt_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -772,10 +772,10 @@ wbt_cosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Optional output html file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -806,10 +806,10 @@ wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, #' @param input1 Input raster file 1. #' @param input2 Input raster file 1. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -838,10 +838,10 @@ wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=N #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -869,10 +869,10 @@ wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=NUL #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -901,10 +901,10 @@ wbt_decrement <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -934,10 +934,10 @@ wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compr #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -966,10 +966,10 @@ wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -997,10 +997,10 @@ wbt_exp <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1028,10 +1028,10 @@ wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1061,10 +1061,10 @@ wbt_floor <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raster #' @param input2 Input raster file or constant value. #' @param output Output raster file. #' @param incl_equals Perform a greater-than-or-equal-to operation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1097,10 +1097,10 @@ wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, #' @param inputs Input raster files. #' @param contiguity Contiguity type. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1131,10 +1131,10 @@ wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL #' #' @param inputs Input raster files. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1168,10 +1168,10 @@ wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=NUL #' @param output2 Output significance (p-value) raster file. #' @param filter Size of the filter kernel. #' @param stat Correlation type; one of 'pearson' (default) and 'spearman'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1212,10 +1212,10 @@ wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1 #' @param standardize Optional flag indicating whether to standardize the residuals map. #' @param scattergram Optional flag indicating whether to output a scattergram. #' @param num_samples Number of samples used to create scattergram. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1256,10 +1256,10 @@ wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, sta #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1287,10 +1287,10 @@ wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=NULL, compres #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1318,10 +1318,10 @@ wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=NULL, comp #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1349,10 +1349,10 @@ wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=NULL, co #' #' @param input1 Input raster file. #' @param input2 Input raster file or constant value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1380,10 +1380,10 @@ wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=NULL, co #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1412,10 +1412,10 @@ wbt_increment <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ra #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1444,10 +1444,10 @@ wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=N #' #' @param inputs Name of the input PCA component images. #' @param report Name of the PCA report file (*.html). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1475,10 +1475,10 @@ wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, ve #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1507,10 +1507,10 @@ wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' @param input1 Input classification raster file. #' @param input2 Input reference raster file. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1540,10 +1540,10 @@ wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, #' @param input Input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1576,10 +1576,10 @@ wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, #' @param input2 Input raster file or constant value. #' @param output Output raster file. #' @param incl_equals Perform a less-than-or-equal-to operation. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1612,10 +1612,10 @@ wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, ve #' @param input Input vector file. #' @param field Input field name in attribute table. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1643,10 +1643,10 @@ wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=N #' @description Lists the unique values contained in a field within a vector's attribute table. #' #' @param input Input vector file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1673,10 +1673,10 @@ wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1704,10 +1704,10 @@ wbt_ln <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=N #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1735,10 +1735,10 @@ wbt_log10 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raster #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1767,10 +1767,10 @@ wbt_log2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1800,10 +1800,10 @@ wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1833,10 +1833,10 @@ wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1866,10 +1866,10 @@ wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compr #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1898,10 +1898,10 @@ wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1930,10 +1930,10 @@ wbt_negate <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -1964,10 +1964,10 @@ wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, #' @param input2 Second input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2000,10 +2000,10 @@ wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, w #' @param input1 Name of the first input raster image file. #' @param input2 Name of the second input raster image file. #' @param output Name of the output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2033,10 +2033,10 @@ wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=NU #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2067,10 +2067,10 @@ wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compre #' @param output Output HTML report file. #' @param num_comp Number of component images to output; <= to num. input images. #' @param standardized Perform standardized PCA?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2105,10 +2105,10 @@ wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, stan #' @param input Input raster file. #' @param output Output raster file. #' @param num_quantiles Number of quantiles. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2139,10 +2139,10 @@ wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode= #' #' @param base Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2171,10 +2171,10 @@ wbt_random_field <- function(base, output, wd=NULL, verbose_mode=NULL, compress_ #' @param base Input raster file. #' @param output Output raster file. #' @param num_samples Number of samples. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2205,10 +2205,10 @@ wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_m #' #' @param statement Statement e.g. cos("raster1") * 35.0 + "raster2". This statement must be a valid Rust statement. #' @param output Name of the output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2238,10 +2238,10 @@ wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=NU #' #' @param input Input raster file. #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2268,10 +2268,10 @@ wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=NULL, comp #' @description Measures a rasters min, max, average, standard deviation, num. non-nodata cells, and total. #' #' @param input Input raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2298,10 +2298,10 @@ wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=NULL, compress #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2333,10 +2333,10 @@ wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' @param out_max_val New maximum value in output image. #' @param clip_min Optional lower tail clip value. #' @param clip_max Optional upper tail clip value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2372,10 +2372,10 @@ wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, cli #' #' @param input Input raster file. #' @param base Input base raster file used for comparison. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2403,10 +2403,10 @@ wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=NULL, #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2434,10 +2434,10 @@ wbt_round <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raster #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2465,10 +2465,10 @@ wbt_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2496,10 +2496,10 @@ wbt_sinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2527,10 +2527,10 @@ wbt_square <- function(input, output, wd=NULL, verbose_mode=NULL, compress_raste #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2559,10 +2559,10 @@ wbt_square_root <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ #' @param input1 Input raster file or constant value. #' @param input2 Input raster file or constant value. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2591,10 +2591,10 @@ wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, com #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2622,10 +2622,10 @@ wbt_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters= #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2653,10 +2653,10 @@ wbt_tanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2684,10 +2684,10 @@ wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2716,10 +2716,10 @@ wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=NULL, compress_r #' @param input Input raster file. #' @param output Output raster file. #' @param order Polynomial order (1 to 10). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2753,10 +2753,10 @@ wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=NULL #' @param output Output raster file. #' @param order Polynomial order (1 to 10). #' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2790,10 +2790,10 @@ wbt_trend_surface_vector_points <- function(input, field, output, cell_size, ord #' @param input Input raster file. #' @param output Output raster file. #' @param num_decimals Number of decimals left after truncation (default is zero). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2826,10 +2826,10 @@ wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode #' @param output Output file. #' @param range The field's range, in xy-units, related to the extent of spatial autocorrelation. #' @param iterations The number of iterations. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2863,10 +2863,10 @@ wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, w #' @param input2 Second input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2900,10 +2900,10 @@ wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd= #' @param input2 Second input raster file. #' @param output Output HTML file. #' @param num_samples Number of samples. Leave blank to use whole image. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2936,10 +2936,10 @@ wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NU #' @param input1 Input raster file. #' @param input2 Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -2968,10 +2968,10 @@ wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress #' #' @param input Input raster file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' @@ -3002,10 +3002,10 @@ wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=NULL, compress_ras #' @param output Output raster file. #' @param stat Statistic to extract, including 'mean', 'median', 'minimum', 'maximum', 'range', 'standard deviation', and 'total'. #' @param out_table Output HTML Table file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords MathandStatsTools #' diff --git a/R/precision_agriculture.R b/R/precision_agriculture.R index bc7d03b5e..50c22d70f 100644 --- a/R/precision_agriculture.R +++ b/R/precision_agriculture.R @@ -10,10 +10,10 @@ #' @param min_yield Minimum yield value in output. #' @param max_yield Maximum yield value in output. #' @param mean_tonnage Use this optional parameter to force the output to have a certain overall average tonnage. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -59,10 +59,10 @@ wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, out #' @param output_points Name of the output points shapefile. #' @param max_change_in_heading Max change in heading. #' @param ignore_zeros Ignore zero-valued yield points?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -101,10 +101,10 @@ wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, outpu #' @param dist Average distance between passes, in meters. #' @param max_change_in_heading Max change in heading. #' @param flag_edges Don't remove edge points, just flag them in the attribute table?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -147,10 +147,10 @@ wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in #' @param z_score_threshold Z-score threshold value (default=2.5). #' @param min_yield Minimum yield value in output. #' @param max_yield Maximum yield value in output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -195,10 +195,10 @@ wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096 #' @param output Name of the output polygon shapefile. #' @param width Pass swath width (m). #' @param max_change_in_heading Max change in heading. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' @@ -238,10 +238,10 @@ wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_chang #' @param radius Optional search radius, in metres. Only specify this value if you want to calculate locally normalized yield. #' @param min_yield Minimum yield value in output. #' @param max_yield Maximum yield value in output. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords PrecisionAgriculture #' diff --git a/R/stream_network_analysis.R b/R/stream_network_analysis.R index b2823354f..914f94744 100644 --- a/R/stream_network_analysis.R +++ b/R/stream_network_analysis.R @@ -7,10 +7,10 @@ #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -47,10 +47,10 @@ wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, ze #' @param output Output raster file. #' @param threshold Threshold in flow accumulation values for channelization. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -85,10 +85,10 @@ wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=F #' @param variant Options include 'LQ' (lower quartile), 'JandR' (Johnston and Rosenfeld), and 'PandD' (Peucker and Douglas); default is 'LQ'. #' @param line_thin Optional flag indicating whether post-processing line-thinning should be performed. #' @param filter Optional argument (only used when variant='lq') providing the filter size, in grid cells, used for lq-filtering (default is 5). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -128,10 +128,10 @@ wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filte #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -169,10 +169,10 @@ wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -210,10 +210,10 @@ wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_b #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -251,10 +251,10 @@ wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -292,10 +292,10 @@ wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, z #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -333,10 +333,10 @@ wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr= #' @param dem Input raster DEM file. #' @param output Output HTML file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -372,10 +372,10 @@ wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd= #' @param dem Input raster DEM file. #' @param output Output HTML file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -410,10 +410,10 @@ wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr #' @param d8_pntr Input raster D8 pointer file. #' @param output Output vector file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -448,10 +448,10 @@ wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FAL #' @param output Output raster file. #' @param nodata Use NoData value for background?. #' @param feature_id Use feature number as output value?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -489,10 +489,10 @@ wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id #' @param output Output raster file. #' @param min_length Minimum tributary length (in map units) used for network pruning. #' @param esri_pntr D8 pointer uses the ESRI style scheme. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -526,10 +526,10 @@ wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_ #' @param input Name of the input lines vector file. #' @param output Name of the output lines vector file. #' @param dist Snap distance, in xy units (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -563,10 +563,10 @@ wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, v #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -604,10 +604,10 @@ wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALS #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -645,10 +645,10 @@ wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -686,10 +686,10 @@ wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -727,10 +727,10 @@ wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -769,10 +769,10 @@ wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zer #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -812,10 +812,10 @@ wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -854,10 +854,10 @@ wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -895,10 +895,10 @@ wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FAL #' @param output Output raster file. #' @param esri_pntr D8 pointer uses the ESRI style scheme. #' @param zero_background Flag indicating whether a background value of zero should be used. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' @@ -936,10 +936,10 @@ wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' @param output Name of the output lines shapefile. #' @param cutting_height Maximum ridge-cutting height (z units). #' @param snap Snap distance, in xy units (metres). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords StreamNetworkAnalysis #' diff --git a/R/terrain_analysis.R b/R/terrain_analysis.R index 8ac76499f..f08fb929a 100644 --- a/R/terrain_analysis.R +++ b/R/terrain_analysis.R @@ -6,10 +6,10 @@ #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -44,10 +44,10 @@ wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=N #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -81,10 +81,10 @@ wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=NULL, co #' @param output Name of the output lines shapefile. #' @param length Maximum segment length (m). #' @param dist Search distance, in grid cells, used in visibility analysis. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -120,10 +120,10 @@ wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, v #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param filter Size of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -156,10 +156,10 @@ wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, #' @param output Name of the output vector lines file. #' @param threshold Threshold value (0 - infinity but typcially 1 to 5 works well). #' @param min_length Minimum line length, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -194,10 +194,10 @@ wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=N #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param filter Size of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -234,10 +234,10 @@ wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, ver #' @param interval Contour interval. #' @param base Base contour height. #' @param smooth Smoothing filter size (in num. points), e.g. 3, 5, 7, 9, 11. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -287,10 +287,10 @@ wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max #' @param base Base contour height. #' @param smooth Smoothing filter size (in num. points), e.g. 3, 5, 7, 9, 11. #' @param tolerance Tolerance factor, in degrees (0-45); determines generalization level. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -332,10 +332,10 @@ wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smo #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -373,10 +373,10 @@ wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose #' @param mean_plane_dist Distance to void edge at which the mean-plane value is used as an offset, measured in grid cells. #' @param edge_treatment How should void-edge cells be treated? Options include 'use DEM' (default), 'use Fill', 'average'. #' @param weight_value Weight value used for IDW interpolation (default is 2.0). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -416,10 +416,10 @@ wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_tre #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -455,10 +455,10 @@ wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -494,10 +494,10 @@ wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -533,10 +533,10 @@ wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NUL #' @param output Output raster file. #' @param azimuth Wind azimuth in degrees. #' @param max_dist Optional maximum search distance (unspecified if none; in xy units). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -572,10 +572,10 @@ wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=N #' @param output Output raster file. #' @param drop Vertical drop value (default is 2.0). #' @param out_type Output type, options include 'tangent', 'degrees', 'radians', 'distance' (default is 'tangent'). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -612,10 +612,10 @@ wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NU #' @param filter Size of the filter kernel. #' @param norm_diff Maximum difference in normal vectors, in degrees. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -652,10 +652,10 @@ wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -686,10 +686,10 @@ wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=NULL, compress #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. #' @param sig_digits Number of significant digits. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -726,10 +726,10 @@ wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits= #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -758,10 +758,10 @@ wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=NULL #' @param dem Input raster DEM file. #' @param watersheds Input raster watersheds file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -799,10 +799,10 @@ wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=N #' @param max_increment Maximum upwards increment between neighbouring cells on an embankment (in elevation units). #' @param spillout_slope Spillout slope (in degrees). #' @param remove_embankments Optional flag indicating whether to output a DEM with embankments removed (true) or an embankment raster map (false). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -858,10 +858,10 @@ wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_r #' @param azimuth Wind azimuth, in degrees. #' @param max_dist Optional maximum search distance. Minimum value is 5 x cell size. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -903,10 +903,10 @@ wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", #' @param num_iter Number of iterations. #' @param max_diff Maximum allowable absolute elevation change (optional). #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -951,10 +951,10 @@ wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=1 #' @param output Output raster file. #' @param azimuth Wind azimuth in degrees in degrees. #' @param hgt_inc Height increment value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -991,10 +991,10 @@ wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, #' @param filter Filter size (cells). #' @param weight IDW weight value. #' @param no_edges Optional flag indicating whether to exclude NoData cells in edge regions. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1032,10 +1032,10 @@ wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param line_thin Optional flag indicating whether post-processing line-thinning should be performed. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1068,10 +1068,10 @@ wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=N #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1113,10 +1113,10 @@ wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL #' @param num_steps Number of steps. #' @param lsp Output land-surface parameter; one of 'AnisotropyLTP', 'Aspect', 'DiffMeanElev', 'Eastness', 'Elevation', 'Hillshade', 'MeanCurvature', 'Northness', 'PlanCurvature', 'ProfileCurvature', 'Ruggedness', 'Slope', 'TanCurvature', 'TotalCurvature'. #' @param z_factor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1166,10 +1166,10 @@ wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, p #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1209,10 +1209,10 @@ wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL #' @param skip Distance (in cells) to begin calculating lines-of-sight. #' @param forms Classify geomorphons into 10 common land morphologies, else output ternary pattern. #' @param residuals Convert elevation to residuals of a linear model. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1261,10 +1261,10 @@ wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip #' @param azimuth Illumination source azimuth in degrees. #' @param altitude Illumination source altitude in degrees. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1303,10 +1303,10 @@ wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NUL #' @param output Output raster file. #' @param azimuth Azimuth, in degrees. #' @param max_dist Optional maximum search distance (unspecified if none; in xy units). Minimum value is 5 x cell size. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1342,10 +1342,10 @@ wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1380,10 +1380,10 @@ wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, #' @param inputs Input DEM files. #' @param watershed Input watershed files (optional). #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1422,10 +1422,10 @@ wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, ve #' @param reverse Optional flag indicating whether to use reverse the palette. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param full_mode Optional flag indicating whether to use full 360-degrees of illumination sources. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1482,10 +1482,10 @@ wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_ #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1527,10 +1527,10 @@ wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale= #' @param dem Name of the input DEM raster file. #' @param output Name of the output raster file. #' @param filter Edge length of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1563,10 +1563,10 @@ wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbo #' @param output Output raster file. #' @param max_slope Maximum inter-cell absolute slope. #' @param min_size Minimum feature size, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1604,10 +1604,10 @@ wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1647,10 +1647,10 @@ wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1687,10 +1687,10 @@ wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param log Optional flag to request the output be log-transformed. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1725,10 +1725,10 @@ wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode= #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1762,10 +1762,10 @@ wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1797,10 +1797,10 @@ wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NUL #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1838,10 +1838,10 @@ wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1875,10 +1875,10 @@ wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_ #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1908,10 +1908,10 @@ wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1947,10 +1947,10 @@ wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -1984,10 +1984,10 @@ wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2017,10 +2017,10 @@ wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NUL #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2057,10 +2057,10 @@ wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' @param altitude Illumination source altitude in degrees. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param full_mode Optional flag indicating whether to use full 360-degrees of illumination sources. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2105,10 +2105,10 @@ wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=N #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). #' @param log Display output values using a log-scale. #' @param standardize Should each scale be standardized to z-scores?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2166,10 +2166,10 @@ wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2217,10 +2217,10 @@ wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_dig #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2260,10 +2260,10 @@ wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_sca #' @param min_scale Minimum search neighbourhood radius in grid cells. #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param step Step size as any positive non-zero integer. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2304,10 +2304,10 @@ wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, m #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2353,10 +2353,10 @@ wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, #' @param step Step size as any positive non-zero integer. #' @param num_steps Number of steps. #' @param step_nonlinearity Step nonlinearity factor (1.0-2.0 is typical). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2401,10 +2401,10 @@ wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_sc #' @param hillshade Input optional hillshade raster file. Note: a multi-directional (360-degree option) hillshade tends to work best in this application. #' @param output Output raster file. #' @param lightness Image lightness value (default is 1.2). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2440,10 +2440,10 @@ wbt_multiscale_topographic_position_image <- function(local, meso, broad, output #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2471,10 +2471,10 @@ wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2504,10 +2504,10 @@ wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, #' @param pos_output Name of the positive openness output raster file. #' @param neg_output Name of the negative openness output raster file. #' @param dist Search distance, in grid cells. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2543,10 +2543,10 @@ wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbos #' @param prof Profile curvature threshold value (default is 0.1). #' @param plan Plan curvature threshold value (default is 0.0). #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2588,10 +2588,10 @@ wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0. #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2627,10 +2627,10 @@ wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, v #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2665,10 +2665,10 @@ wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' @param lines Input vector line file. #' @param surface Input raster surface file. #' @param output Output HTML file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2699,10 +2699,10 @@ wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=NULL, comp #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2738,10 +2738,10 @@ wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' @param output Output raster file. #' @param azimuth Illumination source azimuth. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2777,10 +2777,10 @@ wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, #' @param output Output raster file. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2816,10 +2816,10 @@ wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=1 #' @param output Output raster file. #' @param filter Filter size (cells). #' @param slope Slope threshold value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2855,10 +2855,10 @@ wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, w #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2894,10 +2894,10 @@ wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, ver #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2931,10 +2931,10 @@ wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -2965,10 +2965,10 @@ wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=NULL, compre #' @param output Output raster file. #' @param sca_exponent SCA exponent value. #' @param slope_exponent Slope exponent value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3011,10 +3011,10 @@ wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, s #' @param height Image height, in pixels. #' @param delay GIF time delay in milliseconds. #' @param label Label text (leave blank for none). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3071,10 +3071,10 @@ wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", da #' @param date Date in format DD/MM/YYYY. #' @param time Time in format HH::MM, e.g. 03:15AM or 14:30. #' @param location Location, defined as Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3118,10 +3118,10 @@ wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="2 #' @param dem Name of the input raster DEM file. #' @param output Name of the output raster image file. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3154,10 +3154,10 @@ wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=NULL #' @param output Output raster file. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param units Units of output raster; options include 'degrees', 'radians', 'percent'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3194,10 +3194,10 @@ wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbo #' @param bin_size Aspect bin size, in degrees. #' @param min_slope Minimum slope, in degrees. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3235,10 +3235,10 @@ wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, #' @param inputs Input DEM files. #' @param watershed Input watershed files (optional). #' @param output Output HTML file (default name will be based on input file if unspecified). -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3272,10 +3272,10 @@ wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, #' @param max_scale Maximum search neighbourhood radius in grid cells. #' @param dev_threshold DEVmax Threshold. #' @param scale_threshold DEVmax scale threshold. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3313,10 +3313,10 @@ wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_thre #' @param dem Input raster DEM file. #' @param output Output raster file. #' @param filter Size of the filter kernel. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3350,10 +3350,10 @@ wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, ve #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. #' @param filterx Size of the filter kernel in the x-direction. #' @param filtery Size of the filter kernel in the y-direction. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3392,10 +3392,10 @@ wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx #' @param slope Input raster slope file. #' @param output Output raster file. #' @param exponent SCA exponent value. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3427,10 +3427,10 @@ wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, ve #' #' @param dem Input raster DEM file. #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3460,10 +3460,10 @@ wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=NULL, comp #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3506,10 +3506,10 @@ wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NU #' @param end_day End day of the year (1-365). #' @param start_time Starting hour to track shadows (e.g. 5, 5:00, 05:00:00). Assumes 24-hour time: HH:MM:SS. 'sunrise' is also a valid time. #' @param end_time Ending hour to track shadows (e.g. 21, 21:00, 21:00:00). Assumes 24-hour time: HH:MM:SS. 'sunset' is also a valid time. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3570,10 +3570,10 @@ wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_d #' @param attenuation Attenuation parameter. Range is 0-4. Zero means no attenuation. #' @param ambient_light Ambient light parameter. Range is 0.0-0.7. Zero means no ambient light. #' @param z_factor Elevation multiplier, or a vertical exageration. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3640,10 +3640,10 @@ wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=3 #' @param delay GIF time delay in milliseconds. #' @param label Label text (leave blank for none). #' @param dev_max Do you want to use DEVmax instead of DEV for measuring local topographic position?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3697,10 +3697,10 @@ wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd" #' @param output Output raster file. #' @param log Display output values using a log-scale. #' @param zfactor Optional multiplier for when the vertical and horizontal units are not the same. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3736,10 +3736,10 @@ wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, v #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3775,10 +3775,10 @@ wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbo #' @param output Name of the output raster image file. #' @param log Display output values using a log-scale. #' @param zfactor Z conversion factor. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3814,10 +3814,10 @@ wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, w #' @param stations Input viewing station vector file. #' @param output Output raster file. #' @param height Viewing station height, in z units. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3851,10 +3851,10 @@ wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mod #' @param output Output raster file. #' @param height Viewing station height, in z units. #' @param res_factor The resolution factor determines the density of measured viewsheds. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' @@ -3889,10 +3889,10 @@ wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, #' @param sca Input raster specific contributing area (SCA) file. #' @param slope Input raster slope file (in degrees). #' @param output Output raster file. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords GeomorphometricAnalysis #' diff --git a/R/whitebox_utilities.R b/R/whitebox_utilities.R index 5dd65f08a..9bcd063b4 100644 --- a/R/whitebox_utilities.R +++ b/R/whitebox_utilities.R @@ -3,10 +3,10 @@ #' @description Use to install a Whitebox extension product. #' #' @param install_extension Name of the extension product to install. Options include: 'General Toolset Extension', 'DEM & Spatial Hydrology Extension', 'Lidar & Remote Sensing Extension', and 'Agriculture Extension'. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords WhiteboxUtilities #' @@ -34,10 +34,10 @@ wbt_install_wb_extension <- function(install_extension="General Toolset Extensio #' @description Opens the Whitebox Runner application. #' #' @param clear_app_state Clear the application state memory?. -#' @param wd Changes the working directory. -#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. -#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. -#' @param command_only Return command that would be executed by `system()` rather than running tool. +#' @param wd Changes the working directory. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_wd()` for details. +#' @param verbose_mode Sets verbose mode. If verbose mode is `FALSE`, tools will not print output messages. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_verbose()` for details. +#' @param compress_rasters Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: `NULL` will use the value in WhiteboxTools settings, see `wbt_compress_rasters()` for details. +#' @param command_only Return command that would be executed by `system()` rather than running tool. Default: `FALSE`. #' #' @keywords WhiteboxUtilities #'