From 9123e559eafe0df4c854f2556d4ba09e5c92ca48 Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Sun, 1 Oct 2023 08:51:29 -0700 Subject: [PATCH 1/7] Update default arguments in function definitions for `compress_rasters`, `verbose_mode` --- PY2R/automation.py | 2 +- PY2R/scripts/data_tools.R | 54 +++--- PY2R/scripts/gis_analysis.R | 88 ++++----- PY2R/scripts/gis_analysis_distance.R | 12 +- PY2R/scripts/gis_analysis_overlay.R | 58 +++--- PY2R/scripts/gis_analysis_patch_shape.R | 28 +-- PY2R/scripts/hydro_analysis.R | 120 ++++++------ PY2R/scripts/image_analysis.R | 40 ++-- PY2R/scripts/image_analysis_classification.R | 12 +- PY2R/scripts/image_analysis_enhancement.R | 28 +-- PY2R/scripts/image_analysis_filters.R | 70 +++---- PY2R/scripts/lidar_analysis.R | 130 ++++++------- PY2R/scripts/machine_learning.R | 20 +- PY2R/scripts/math_stat_analysis.R | 180 +++++++++--------- PY2R/scripts/precision_agriculture.R | 12 +- PY2R/scripts/stream_network_analysis.R | 48 ++--- PY2R/scripts/terrain_analysis.R | 188 +++++++++---------- PY2R/scripts/whitebox_utilities.R | 4 +- R/data_tools.R | 54 +++--- R/gis_analysis.R | 88 ++++----- R/gis_analysis_distance.R | 12 +- R/gis_analysis_overlay.R | 58 +++--- R/gis_analysis_patch_shape.R | 28 +-- R/hydro_analysis.R | 120 ++++++------ R/image_analysis.R | 40 ++-- R/image_analysis_classification.R | 12 +- R/image_analysis_enhancement.R | 28 +-- R/image_analysis_filters.R | 70 +++---- R/lidar_analysis.R | 130 ++++++------- R/machine_learning.R | 20 +- R/math_stat_analysis.R | 180 +++++++++--------- R/precision_agriculture.R | 12 +- R/stream_network_analysis.R | 48 ++--- R/terrain_analysis.R | 188 +++++++++---------- R/wbt.R | 2 +- R/whitebox_utilities.R | 4 +- 36 files changed, 1094 insertions(+), 1094 deletions(-) diff --git a/PY2R/automation.py b/PY2R/automation.py index f63e3d6f4..e5efdf5e4 100644 --- a/PY2R/automation.py +++ b/PY2R/automation.py @@ -31,7 +31,7 @@ def function_header(line): line = line.replace(", i=None,", ", input=None,") line = line.replace("self, ", "") line = line.replace( - "callback=None", "wd=NULL, verbose_mode=FALSE, compress_rasters=False" + "callback=None", "wd=NULL, verbose_mode=NULL, compress_rasters=NULL" ) line = line.replace('function=""', 'FUN=""') line = line.replace("False", "FALSE") diff --git a/PY2R/scripts/data_tools.R b/PY2R/scripts/data_tools.R index 0dfab8320..8c3cec1f7 100644 --- a/PY2R/scripts/data_tools.R +++ b/PY2R/scripts/data_tools.R @@ -12,7 +12,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -42,7 +42,7 @@ wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -73,7 +73,7 @@ wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -104,7 +104,7 @@ wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -138,7 +138,7 @@ wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -179,7 +179,7 @@ wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -214,7 +214,7 @@ wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -251,7 +251,7 @@ wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -287,7 +287,7 @@ wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -321,7 +321,7 @@ wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -357,7 +357,7 @@ wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -388,7 +388,7 @@ wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -422,7 +422,7 @@ wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -459,7 +459,7 @@ wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="float", cell_size=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="float", cell_size=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -499,7 +499,7 @@ wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="fl #' #' @return Returns the tool text outputs. #' @export -wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -529,7 +529,7 @@ wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -559,7 +559,7 @@ wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -590,7 +590,7 @@ wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -621,7 +621,7 @@ wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -651,7 +651,7 @@ wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -681,7 +681,7 @@ wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -714,7 +714,7 @@ wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diagonals=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diagonals=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -752,7 +752,7 @@ wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diag #' #' @return Returns the tool text outputs. #' @export -wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -787,7 +787,7 @@ wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -825,7 +825,7 @@ wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -873,7 +873,7 @@ wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, #' #' @return Returns the tool text outputs. #' @export -wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -923,7 +923,7 @@ wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last #' #' @return Returns the tool text outputs. #' @export -wbt_vector_polygons_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_polygons_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/gis_analysis.R b/PY2R/scripts/gis_analysis.R index 125282f0c..26e68c95f 100644 --- a/PY2R/scripts/gis_analysis.R +++ b/PY2R/scripts/gis_analysis.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -56,7 +56,7 @@ wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -101,7 +101,7 @@ wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' #' @return Returns the tool text outputs. #' @export -wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -143,7 +143,7 @@ wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' #' @return Returns the tool text outputs. #' @export -wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -177,7 +177,7 @@ wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -210,7 +210,7 @@ wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -250,7 +250,7 @@ wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -292,7 +292,7 @@ wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max #' #' @return Returns the tool text outputs. #' @export -wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -330,7 +330,7 @@ wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation=" #' #' @return Returns the tool text outputs. #' @export -wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -374,7 +374,7 @@ wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant= #' #' @return Returns the tool text outputs. #' @export -wbt_create_rectangular_vector_grid <- function(input, output, width, height, xorig=0, yorig=0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_rectangular_vector_grid <- function(input, output, width, height, xorig=0, yorig=0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -415,7 +415,7 @@ wbt_create_rectangular_vector_grid <- function(input, output, width, height, xor #' #' @return Returns the tool text outputs. #' @export -wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -453,7 +453,7 @@ wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -487,7 +487,7 @@ wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -522,7 +522,7 @@ wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd= #' #' @return Returns the tool text outputs. #' @export -wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -554,7 +554,7 @@ wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=FALSE, compre #' #' @return Returns the tool text outputs. #' @export -wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -590,7 +590,7 @@ wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_filter_raster_features_by_area <- function(input, output, threshold, background="zero", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_raster_features_by_area <- function(input, output, threshold, background="zero", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -626,7 +626,7 @@ wbt_filter_raster_features_by_area <- function(input, output, threshold, backgro #' #' @return Returns the tool text outputs. #' @export -wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -665,7 +665,7 @@ wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", #' #' @return Returns the tool text outputs. #' @export -wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel="quartic", cell_size="", base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel="quartic", cell_size="", base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -718,7 +718,7 @@ wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel= #' #' @return Returns the tool text outputs. #' @export -wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, radius=NULL, min_points=NULL, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, radius=NULL, min_points=NULL, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -768,7 +768,7 @@ wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, #' #' @return Returns the tool text outputs. #' @export -wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -799,7 +799,7 @@ wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_medoid <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_medoid <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -832,7 +832,7 @@ wbt_medoid <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_bounding_box <- function(input, output, criterion="area", features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_bounding_box <- function(input, output, criterion="area", features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -870,7 +870,7 @@ wbt_minimum_bounding_box <- function(input, output, criterion="area", features=T #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -905,7 +905,7 @@ wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -940,7 +940,7 @@ wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -979,7 +979,7 @@ wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z=FALSE, cell_size=NULL, base=NULL, clip=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z=FALSE, cell_size=NULL, base=NULL, clip=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1030,7 +1030,7 @@ wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z #' #' @return Returns the tool text outputs. #' @export -wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, max_dist=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, max_dist=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1073,7 +1073,7 @@ wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, ce #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_area <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_area <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1103,7 +1103,7 @@ wbt_polygon_area <- function(input, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1133,7 +1133,7 @@ wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1163,7 +1163,7 @@ wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1203,7 +1203,7 @@ wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_radial_basis_function_interpolation <- function(input, field, output, use_z=FALSE, radius=NULL, min_points=NULL, func_type="ThinPlateSpline", poly_order="none", weight=0.1, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_radial_basis_function_interpolation <- function(input, field, output, use_z=FALSE, radius=NULL, min_points=NULL, func_type="ThinPlateSpline", poly_order="none", weight=0.1, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1262,7 +1262,7 @@ wbt_radial_basis_function_interpolation <- function(input, field, output, use_z= #' #' @return Returns the tool text outputs. #' @export -wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1305,7 +1305,7 @@ wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cell #' #' @return Returns the tool text outputs. #' @export -wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1342,7 +1342,7 @@ wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1386,7 +1386,7 @@ wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid #' #' @return Returns the tool text outputs. #' @export -wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1424,7 +1424,7 @@ wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=NULL, end_val=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=NULL, end_val=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1465,7 +1465,7 @@ wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=N #' #' @return Returns the tool text outputs. #' @export -wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1498,7 +1498,7 @@ wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1533,7 +1533,7 @@ wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1572,7 +1572,7 @@ wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution=NULL, base=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution=NULL, base=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1619,7 +1619,7 @@ wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution= #' #' @return Returns the tool text outputs. #' @export -wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1655,7 +1655,7 @@ wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1690,7 +1690,7 @@ wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal #' #' @return Returns the tool text outputs. #' @export -wbt_voronoi_diagram <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_voronoi_diagram <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/gis_analysis_distance.R b/PY2R/scripts/gis_analysis_distance.R index f91cbaf97..6fbf71845 100644 --- a/PY2R/scripts/gis_analysis_distance.R +++ b/PY2R/scripts/gis_analysis_distance.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -51,7 +51,7 @@ wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--source=", wbt_file_path(source))) @@ -85,7 +85,7 @@ wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--source=", wbt_file_path(source))) @@ -120,7 +120,7 @@ wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--destination=", wbt_file_path(destination))) @@ -155,7 +155,7 @@ wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -186,7 +186,7 @@ wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_euclidean_distance <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_euclidean_distance <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/gis_analysis_overlay.R b/PY2R/scripts/gis_analysis_overlay.R index 03a2f1642..3be465fff 100644 --- a/PY2R/scripts/gis_analysis_overlay.R +++ b/PY2R/scripts/gis_analysis_overlay.R @@ -13,7 +13,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -45,7 +45,7 @@ wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -79,7 +79,7 @@ wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensions=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensions=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -115,7 +115,7 @@ wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensi #' #' @return Returns the tool text outputs. #' @export -wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -148,7 +148,7 @@ wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -181,7 +181,7 @@ wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -214,7 +214,7 @@ wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -246,7 +246,7 @@ wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verb #' #' @return Returns the tool text outputs. #' @export -wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -279,7 +279,7 @@ wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -315,7 +315,7 @@ wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -347,7 +347,7 @@ wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -378,7 +378,7 @@ wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -409,7 +409,7 @@ wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -441,7 +441,7 @@ wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -475,7 +475,7 @@ wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -506,7 +506,7 @@ wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -537,7 +537,7 @@ wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -569,7 +569,7 @@ wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -602,7 +602,7 @@ wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -635,7 +635,7 @@ wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -668,7 +668,7 @@ wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -700,7 +700,7 @@ wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -732,7 +732,7 @@ wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -764,7 +764,7 @@ wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -797,7 +797,7 @@ wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -834,7 +834,7 @@ wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -870,7 +870,7 @@ wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -906,7 +906,7 @@ wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraints=NULL, scale_max=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraints=NULL, scale_max=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--factors=", wbt_file_path(factors))) @@ -948,7 +948,7 @@ wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraint #' #' @return Returns the tool text outputs. #' @export -wbt_weighted_sum <- function(inputs, weights, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_weighted_sum <- function(inputs, weights, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) diff --git a/PY2R/scripts/gis_analysis_patch_shape.R b/PY2R/scripts/gis_analysis_patch_shape.R index 9aaece538..01e55ec3c 100644 --- a/PY2R/scripts/gis_analysis_patch_shape.R +++ b/PY2R/scripts/gis_analysis_patch_shape.R @@ -13,7 +13,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -43,7 +43,7 @@ wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -74,7 +74,7 @@ wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -107,7 +107,7 @@ wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -137,7 +137,7 @@ wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_ra #' #' @return Returns the tool text outputs. #' @export -wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -167,7 +167,7 @@ wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -196,7 +196,7 @@ wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_linearity_index <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_linearity_index <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -226,7 +226,7 @@ wbt_linearity_index <- function(input, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -256,7 +256,7 @@ wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -285,7 +285,7 @@ wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -316,7 +316,7 @@ wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -349,7 +349,7 @@ wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -378,7 +378,7 @@ wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -408,7 +408,7 @@ wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_shape_complexity_index_raster <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shape_complexity_index_raster <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/hydro_analysis.R b/PY2R/scripts/hydro_analysis.R index c3012c83d..ef1712405 100644 --- a/PY2R/scripts/hydro_analysis.R +++ b/PY2R/scripts/hydro_analysis.R @@ -13,7 +13,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -44,7 +44,7 @@ wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -76,7 +76,7 @@ wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -114,7 +114,7 @@ wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, flat_increment=NULL, fill_pits=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, flat_increment=NULL, fill_pits=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -162,7 +162,7 @@ wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, min_dist=TRUE, flat_increment=NULL, fill=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, min_dist=TRUE, flat_increment=NULL, fill=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -206,7 +206,7 @@ wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -240,7 +240,7 @@ wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -281,7 +281,7 @@ wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, w #' #' @return Returns the tool text outputs. #' @export -wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -330,7 +330,7 @@ wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -365,7 +365,7 @@ wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -404,7 +404,7 @@ wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contributing Area", threshold=NULL, log=FALSE, clip=FALSE, pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contributing Area", threshold=NULL, log=FALSE, clip=FALSE, pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -453,7 +453,7 @@ wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contri #' #' @return Returns the tool text outputs. #' @export -wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -487,7 +487,7 @@ wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd #' #' @return Returns the tool text outputs. #' @export -wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -519,7 +519,7 @@ wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -555,7 +555,7 @@ wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -594,7 +594,7 @@ wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -632,7 +632,7 @@ wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, w #' #' @return Returns the tool text outputs. #' @export -wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weights=NULL, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weights=NULL, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -674,7 +674,7 @@ wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weig #' #' @return Returns the tool text outputs. #' @export -wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -712,7 +712,7 @@ wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd= #' #' @return Returns the tool text outputs. #' @export -wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -745,7 +745,7 @@ wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -782,7 +782,7 @@ wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -828,7 +828,7 @@ wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributi #' #' @return Returns the tool text outputs. #' @export -wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -860,7 +860,7 @@ wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -895,7 +895,7 @@ wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, max_depth=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, max_depth=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -937,7 +937,7 @@ wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -976,7 +976,7 @@ wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRU #' #' @return Returns the tool text outputs. #' @export -wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1013,7 +1013,7 @@ wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_ #' #' @return Returns the tool text outputs. #' @export -wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1044,7 +1044,7 @@ wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1076,7 +1076,7 @@ wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -1109,7 +1109,7 @@ wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1141,7 +1141,7 @@ wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1178,7 +1178,7 @@ wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accum, out_type="Specific Contributing Area", log=FALSE, clip=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accum, out_type="Specific Contributing Area", log=FALSE, clip=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1224,7 +1224,7 @@ wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accu #' #' @return Returns the tool text outputs. #' @export -wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -1260,7 +1260,7 @@ wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verb #' #' @return Returns the tool text outputs. #' @export -wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -1298,7 +1298,7 @@ wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, threshold=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, threshold=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1341,7 +1341,7 @@ wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, thr #' #' @return Returns the tool text outputs. #' @export -wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NULL, out_volume=NULL, out_area=NULL, out_dam_height=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NULL, out_volume=NULL, out_area=NULL, out_dam_height=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1389,7 +1389,7 @@ wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NU #' #' @return Returns the tool text outputs. #' @export -wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1424,7 +1424,7 @@ wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1461,7 +1461,7 @@ wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--pour_pts=", wbt_file_path(pour_pts))) @@ -1495,7 +1495,7 @@ wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd #' #' @return Returns the tool text outputs. #' @export -wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1528,7 +1528,7 @@ wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1560,7 +1560,7 @@ wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1592,7 +1592,7 @@ wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1629,7 +1629,7 @@ wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1675,7 +1675,7 @@ wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contrib #' #' @return Returns the tool text outputs. #' @export -wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1712,7 +1712,7 @@ wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=10.0, max_slope=45.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=10.0, max_slope=45.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1766,7 +1766,7 @@ wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributi #' #' @return Returns the tool text outputs. #' @export -wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1815,7 +1815,7 @@ wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contribu #' #' @return Returns the tool text outputs. #' @export -wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1858,7 +1858,7 @@ wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contributing area", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contributing area", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1905,7 +1905,7 @@ wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contrib #' #' @return Returns the tool text outputs. #' @export -wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1941,7 +1941,7 @@ wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1979,7 +1979,7 @@ wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2015,7 +2015,7 @@ wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--pour_pts=", wbt_file_path(pour_pts))) @@ -2051,7 +2051,7 @@ wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterations=100, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterations=100, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2089,7 +2089,7 @@ wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterati #' #' @return Returns the tool text outputs. #' @export -wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -2126,7 +2126,7 @@ wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -2164,7 +2164,7 @@ wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--seed_pts=", wbt_file_path(seed_pts))) @@ -2204,7 +2204,7 @@ wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=F #' #' @return Returns the tool text outputs. #' @export -wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -2239,7 +2239,7 @@ wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2272,7 +2272,7 @@ wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_watershed <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_watershed <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) diff --git a/PY2R/scripts/image_analysis.R b/PY2R/scripts/image_analysis.R index 525d1bd88..e5f37393d 100644 --- a/PY2R/scripts/image_analysis.R +++ b/PY2R/scripts/image_analysis.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--date1=", wbt_file_path(date1))) @@ -50,7 +50,7 @@ wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -92,7 +92,7 @@ wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, enhance=TRUE, zeros=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, enhance=TRUE, zeros=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--red=", wbt_file_path(red))) @@ -135,7 +135,7 @@ wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -174,7 +174,7 @@ wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--intensity=", wbt_file_path(intensity))) @@ -226,7 +226,7 @@ wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' #' @return Returns the tool text outputs. #' @export -wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=FALSE, label1="", palette2="grey", reverse2=FALSE, label2="", height=600, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=FALSE, label1="", palette2="grey", reverse2=FALSE, label2="", height=600, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -280,7 +280,7 @@ wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=F #' #' @return Returns the tool text outputs. #' @export -wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -312,7 +312,7 @@ wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -343,7 +343,7 @@ wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -375,7 +375,7 @@ wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=FALSE, compre #' #' @return Returns the tool text outputs. #' @export -wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--output=", wbt_file_path(output))) @@ -414,7 +414,7 @@ wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weight=4.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weight=4.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -455,7 +455,7 @@ wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weig #' #' @return Returns the tool text outputs. #' @export -wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, correction=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, correction=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -495,7 +495,7 @@ wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, co #' #' @return Returns the tool text outputs. #' @export -wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -533,7 +533,7 @@ wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -570,7 +570,7 @@ wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -615,7 +615,7 @@ wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", #' #' @return Returns the tool text outputs. #' @export -wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, composite=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, composite=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--intensity=", wbt_file_path(intensity))) @@ -661,7 +661,7 @@ wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' #' @return Returns the tool text outputs. #' @export -wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -700,7 +700,7 @@ wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, w #' #' @return Returns the tool text outputs. #' @export -wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -734,7 +734,7 @@ wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant="white", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant="white", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -776,7 +776,7 @@ wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant= #' #' @return Returns the tool text outputs. #' @export -wbt_write_function_memory_insertion <- function(input1, input2, output, input3=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_write_function_memory_insertion <- function(input1, input2, output, input3=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) diff --git a/PY2R/scripts/image_analysis_classification.R b/PY2R/scripts/image_analysis_classification.R index 2e28a22b9..e0040119b 100644 --- a/PY2R/scripts/image_analysis_classification.R +++ b/PY2R/scripts/image_analysis_classification.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -50,7 +50,7 @@ wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_generalize_classified_raster <- function(input, output, min_size=4, method="longest", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_generalize_classified_raster <- function(input, output, min_size=4, method="longest", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -89,7 +89,7 @@ wbt_generalize_classified_raster <- function(input, output, min_size=4, method=" #' #' @return Returns the tool text outputs. #' @export -wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -127,7 +127,7 @@ wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4 #' #' @return Returns the tool text outputs. #' @export -wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_area=4, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_area=4, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -170,7 +170,7 @@ wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_ #' #' @return Returns the tool text outputs. #' @export -wbt_min_dist_classification <- function(inputs, polys, field, output, threshold=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_dist_classification <- function(inputs, polys, field, output, threshold=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -208,7 +208,7 @@ wbt_min_dist_classification <- function(inputs, polys, field, output, threshold= #' #' @return Returns the tool text outputs. #' @export -wbt_parallelepiped_classification <- function(inputs, polys, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_parallelepiped_classification <- function(inputs, polys, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) diff --git a/PY2R/scripts/image_analysis_enhancement.R b/PY2R/scripts/image_analysis_enhancement.R index a43ce07f3..7ebce27ef 100644 --- a/PY2R/scripts/image_analysis_enhancement.R +++ b/PY2R/scripts/image_analysis_enhancement.R @@ -14,7 +14,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -52,7 +52,7 @@ wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_width=228.6, n=4.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_width=228.6, n=4.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -95,7 +95,7 @@ wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_ #' #' @return Returns the tool text outputs. #' @export -wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -133,7 +133,7 @@ wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -168,7 +168,7 @@ wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -203,7 +203,7 @@ wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -238,7 +238,7 @@ wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -271,7 +271,7 @@ wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -306,7 +306,7 @@ wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -347,7 +347,7 @@ wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_to #' #' @return Returns the tool text outputs. #' @export -wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue=NULL, composite=NULL, method="brovey", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue=NULL, composite=NULL, method="brovey", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--pan=", wbt_file_path(pan))) @@ -396,7 +396,7 @@ wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue= #' #' @return Returns the tool text outputs. #' @export -wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both", num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both", num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -438,7 +438,7 @@ wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both" #' #' @return Returns the tool text outputs. #' @export -wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -478,7 +478,7 @@ wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024 #' #' @return Returns the tool text outputs. #' @export -wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -520,7 +520,7 @@ wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_standard_deviation_contrast_stretch <- function(input, output, stdev=2.0, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_standard_deviation_contrast_stretch <- function(input, output, stdev=2.0, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/image_analysis_filters.R b/PY2R/scripts/image_analysis_filters.R index 4297acb98..f7e4a2af4 100644 --- a/PY2R/scripts/image_analysis_filters.R +++ b/PY2R/scripts/image_analysis_filters.R @@ -16,7 +16,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -58,7 +58,7 @@ wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold #' #' @return Returns the tool text outputs. #' @export -wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -99,7 +99,7 @@ wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0.15, add_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0.15, add_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -144,7 +144,7 @@ wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0. #' #' @return Returns the tool text outputs. #' @export -wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -181,7 +181,7 @@ wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery= #' #' @return Returns the tool text outputs. #' @export -wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -214,7 +214,7 @@ wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -253,7 +253,7 @@ wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, w #' #' @return Returns the tool text outputs. #' @export -wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -292,7 +292,7 @@ wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -329,7 +329,7 @@ wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, #' #' @return Returns the tool text outputs. #' @export -wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -367,7 +367,7 @@ wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -402,7 +402,7 @@ wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -438,7 +438,7 @@ wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -477,7 +477,7 @@ wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma #' #' @return Returns the tool text outputs. #' @export -wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -517,7 +517,7 @@ wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -560,7 +560,7 @@ wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, s #' #' @return Returns the tool text outputs. #' @export -wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -602,7 +602,7 @@ wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5 #' #' @return Returns the tool text outputs. #' @export -wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -640,7 +640,7 @@ wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -678,7 +678,7 @@ wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10.0, m=5.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10.0, m=5.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -724,7 +724,7 @@ wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10 #' #' @return Returns the tool text outputs. #' @export -wbt_line_detection_filter <- function(input, output, variant="vertical", absvals=FALSE, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_line_detection_filter <- function(input, output, variant="vertical", absvals=FALSE, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -766,7 +766,7 @@ wbt_line_detection_filter <- function(input, output, variant="vertical", absvals #' #' @return Returns the tool text outputs. #' @export -wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -805,7 +805,7 @@ wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -844,7 +844,7 @@ wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -884,7 +884,7 @@ wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -926,7 +926,7 @@ wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits= #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -965,7 +965,7 @@ wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1005,7 +1005,7 @@ wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1046,7 +1046,7 @@ wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_dig #' #' @return Returns the tool text outputs. #' @export -wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1082,7 +1082,7 @@ wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1120,7 +1120,7 @@ wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1155,7 +1155,7 @@ wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1191,7 +1191,7 @@ wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1230,7 +1230,7 @@ wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1269,7 +1269,7 @@ wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, #' #' @return Returns the tool text outputs. #' @export -wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1309,7 +1309,7 @@ wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, threshold=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, threshold=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1352,7 +1352,7 @@ wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, thresho #' #' @return Returns the tool text outputs. #' @export -wbt_user_defined_weights_filter <- function(input, weights, output, center="center", normalize=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_user_defined_weights_filter <- function(input, weights, output, center="center", normalize=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/lidar_analysis.R b/PY2R/scripts/lidar_analysis.R index 7e32d6bdf..ff6d936ee 100644 --- a/PY2R/scripts/lidar_analysis.R +++ b/PY2R/scripts/lidar_analysis.R @@ -14,7 +14,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -49,7 +49,7 @@ wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -88,7 +88,7 @@ wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1, oto_threshold=2.0, planarity_threshold=0.85, linearity_threshold=0.70, iterations=30, facade_threshold=0.5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1, oto_threshold=2.0, planarity_threshold=0.85, linearity_threshold=0.70, iterations=30, facade_threshold=0.5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -145,7 +145,7 @@ wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1 #' #' @return Returns the tool text outputs. #' @export -wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion="max scan angle", filter=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion="max scan angle", filter=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -186,7 +186,7 @@ wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion #' #' @return Returns the tool text outputs. #' @export -wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -222,7 +222,7 @@ wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending=50.0, clr_str="", use_unique_clrs_for_buildings=FALSE, radius="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending=50.0, clr_str="", use_unique_clrs_for_buildings=FALSE, radius="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -272,7 +272,7 @@ wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending= #' #' @return Returns the tool text outputs. #' @export -wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_blending=50.0, only="(230,214,170)", first="(0,140,0)", intermediate="(255,0,255)", last="(0,0,255)", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_blending=50.0, only="(230,214,170)", first="(0,140,0)", intermediate="(255,0,255)", last="(0,0,255)", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -325,7 +325,7 @@ wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_b #' #' @return Returns the tool text outputs. #' @export -wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -358,7 +358,7 @@ wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -395,7 +395,7 @@ wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -430,7 +430,7 @@ wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -462,7 +462,7 @@ wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verb #' #' @return Returns the tool text outputs. #' @export -wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -494,7 +494,7 @@ wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -530,7 +530,7 @@ wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -568,7 +568,7 @@ wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius=1.0, min_height=0.0, max_search_radius="", max_height="", only_use_veg=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius=1.0, min_height=0.0, max_search_radius="", max_height="", only_use_veg=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -615,7 +615,7 @@ wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius= #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -645,7 +645,7 @@ wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -677,7 +677,7 @@ wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -706,7 +706,7 @@ wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -738,7 +738,7 @@ wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, compress_ra #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (!is.null(inputs)) { @@ -779,7 +779,7 @@ wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level #' #' @return Returns the tool text outputs. #' @export -wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -813,7 +813,7 @@ wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -850,7 +850,7 @@ wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -889,7 +889,7 @@ wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsubset_class=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsubset_class=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -926,7 +926,7 @@ wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsub #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--in_lidar=", wbt_file_path(in_lidar))) @@ -967,7 +967,7 @@ wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smooth=5, parameter="elevation", returns="all", exclude_cls=NULL, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smooth=5, parameter="elevation", returns="all", exclude_cls=NULL, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1032,7 +1032,7 @@ wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smoot #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, radius=0.5, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, radius=0.5, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1081,7 +1081,7 @@ wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1122,7 +1122,7 @@ wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=FALSE, inclassval=2, outclassval=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=FALSE, inclassval=2, outclassval=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1175,7 +1175,7 @@ wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=F #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbours=0, slope_threshold=45.0, height_threshold=1.0, classify=TRUE, slope_norm=TRUE, height_above_ground=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbours=0, slope_threshold=45.0, height_threshold=1.0, classify=TRUE, slope_norm=TRUE, height_above_ground=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1229,7 +1229,7 @@ wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbo #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1267,7 +1267,7 @@ wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal" #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, radius=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, radius=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1309,7 +1309,7 @@ wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, rad #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1354,7 +1354,7 @@ wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, weight=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, weight=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1414,7 +1414,7 @@ wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1454,7 +1454,7 @@ wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1488,7 +1488,7 @@ wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1531,7 +1531,7 @@ wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolu #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1591,7 +1591,7 @@ wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter=" #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1642,7 +1642,7 @@ wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolutio #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1681,7 +1681,7 @@ wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pulses=FALSE, avg_points_per_pulse=TRUE, z_range=FALSE, intensity_range=FALSE, predom_class=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pulses=FALSE, avg_points_per_pulse=TRUE, z_range=FALSE, intensity_range=FALSE, predom_class=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1740,7 +1740,7 @@ wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pu #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_samples=5, threshold=0.35, model_size=8, max_slope=80.0, classify=FALSE, last_returns=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_samples=5, threshold=0.35, model_size=8, max_slope=80.0, classify=FALSE, last_returns=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1805,7 +1805,7 @@ wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_ #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, num_points=20, exclude_cls=NULL, minz=NULL, maxz=NULL, func_type="ThinPlateSpline", poly_order="none", weight=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, num_points=20, exclude_cls=NULL, minz=NULL, maxz=NULL, func_type="ThinPlateSpline", poly_order="none", weight=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1869,7 +1869,7 @@ wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1907,7 +1907,7 @@ wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, use_median=FALSE, classify=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, use_median=FALSE, classify=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1960,7 +1960,7 @@ wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=65.0, norm_diff=10.0, azimuth=180.0, altitude=30.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=65.0, norm_diff=10.0, azimuth=180.0, altitude=30.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--buildings=", wbt_file_path(buildings))) @@ -2031,7 +2031,7 @@ wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0 #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=80.0, norm_diff=10.0, maxzdiff=1.0, classes=FALSE, ground=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=80.0, norm_diff=10.0, maxzdiff=1.0, classes=FALSE, ground=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2096,7 +2096,7 @@ wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_s #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_diff=2.0, maxzdiff=1.0, classify=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_diff=2.0, maxzdiff=1.0, classify=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2142,7 +2142,7 @@ wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_ #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2188,7 +2188,7 @@ wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", w #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2239,7 +2239,7 @@ wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevat #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2273,7 +2273,7 @@ wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_filtered=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_filtered=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2316,7 +2316,7 @@ wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_ #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, save_filtered=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, save_filtered=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2358,7 +2358,7 @@ wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, origin_y=0.0, min_points=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, origin_y=0.0, min_points=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2404,7 +2404,7 @@ wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, ori #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2445,7 +2445,7 @@ wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls="7,18", minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls="7,18", minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2500,7 +2500,7 @@ wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", re #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2535,7 +2535,7 @@ wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2572,7 +2572,7 @@ wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2607,7 +2607,7 @@ wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2643,7 +2643,7 @@ wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src_id=FALSE, user_data=FALSE, rgb=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src_id=FALSE, user_data=FALSE, rgb=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2687,7 +2687,7 @@ wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src #' #' @return Returns the tool text outputs. #' @export -wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--indir=", wbt_file_path(indir))) @@ -2720,7 +2720,7 @@ wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2758,7 +2758,7 @@ wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2797,7 +2797,7 @@ wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, #' #' @return Returns the tool text outputs. #' @export -wbt_zlidar_to_las <- function(inputs=NULL, outdir=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_zlidar_to_las <- function(inputs=NULL, outdir=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (!is.null(inputs)) { diff --git a/PY2R/scripts/machine_learning.R b/PY2R/scripts/machine_learning.R index e4835cd4b..76327f5b5 100644 --- a/PY2R/scripts/machine_learning.R +++ b/PY2R/scripts/machine_learning.R @@ -16,7 +16,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, min_points=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, min_points=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -62,7 +62,7 @@ wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, mi #' #' @return Returns the tool text outputs. #' @export -wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_iterations=10, class_change=2.0, initialize="diagonal", min_class_size=10, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_iterations=10, class_change=2.0, initialize="diagonal", min_class_size=10, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -115,7 +115,7 @@ wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_i #' #' @return Returns the tool text outputs. #' @export -wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, clip=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, clip=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -168,7 +168,7 @@ wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", #' #' @return Returns the tool text outputs. #' @export -wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, weight=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, weight=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -219,7 +219,7 @@ wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", out #' #' @return Returns the tool text outputs. #' @export -wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -265,7 +265,7 @@ wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize" #' #' @return Returns the tool text outputs. #' @export -wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start_clusters=1000, merge_dist=NULL, max_iterations=10, class_change=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start_clusters=1000, merge_dist=NULL, max_iterations=10, class_change=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -318,7 +318,7 @@ wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start #' #' @return Returns the tool text outputs. #' @export -wbt_random_forest_classification <- function(inputs, training, field, output=NULL, split_criterion="Gini", n_trees=500, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_forest_classification <- function(inputs, training, field, output=NULL, split_criterion="Gini", n_trees=500, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -374,7 +374,7 @@ wbt_random_forest_classification <- function(inputs, training, field, output=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n_trees=100, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n_trees=100, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -428,7 +428,7 @@ wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n #' #' @return Returns the tool text outputs. #' @export -wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, c=200.0, gamma=50.0, tolerance=0.1, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, c=200.0, gamma=50.0, tolerance=0.1, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -485,7 +485,7 @@ wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", #' #' @return Returns the tool text outputs. #' @export -wbt_svm_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, c=50.0, eps=10.0, gamma=0.5, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_svm_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, c=50.0, eps=10.0, gamma=0.5, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) diff --git a/PY2R/scripts/math_stat_analysis.R b/PY2R/scripts/math_stat_analysis.R index 1e6c88f4e..a8fa5e57a 100644 --- a/PY2R/scripts/math_stat_analysis.R +++ b/PY2R/scripts/math_stat_analysis.R @@ -14,7 +14,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -47,7 +47,7 @@ wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -80,7 +80,7 @@ wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -112,7 +112,7 @@ wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -144,7 +144,7 @@ wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -177,7 +177,7 @@ wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -209,7 +209,7 @@ wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -240,7 +240,7 @@ wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -271,7 +271,7 @@ wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -302,7 +302,7 @@ wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -333,7 +333,7 @@ wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -364,7 +364,7 @@ wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_artanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_artanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -396,7 +396,7 @@ wbt_artanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input_y=", wbt_file_path(input_y))) @@ -428,7 +428,7 @@ wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -465,7 +465,7 @@ wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, field2, radius=NULL, min_points=NULL, stat="pearson", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, field2, radius=NULL, min_points=NULL, stat="pearson", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -507,7 +507,7 @@ wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, fiel #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -542,7 +542,7 @@ wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -578,7 +578,7 @@ wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=F #' #' @return Returns the tool text outputs. #' @export -wbt_ceil <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ceil <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -612,7 +612,7 @@ wbt_ceil <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, false=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, false=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -661,7 +661,7 @@ wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, f #' #' @return Returns the tool text outputs. #' @export -wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterations=25000, seed=NULL, prob=0.5, threshold=NULL, temp=1.0, temp_decay=0.05, cycle=10, average=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterations=25000, seed=NULL, prob=0.5, threshold=NULL, temp=1.0, temp_decay=0.05, cycle=10, average=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -719,7 +719,7 @@ wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterati #' #' @return Returns the tool text outputs. #' @export -wbt_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -750,7 +750,7 @@ wbt_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_cosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -781,7 +781,7 @@ wbt_cosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -815,7 +815,7 @@ wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -847,7 +847,7 @@ wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -878,7 +878,7 @@ wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_decrement <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_decrement <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -910,7 +910,7 @@ wbt_decrement <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -943,7 +943,7 @@ wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -975,7 +975,7 @@ wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_exp <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_exp <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1006,7 +1006,7 @@ wbt_exp <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1037,7 +1037,7 @@ wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_floor <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_floor <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1070,7 +1070,7 @@ wbt_floor <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1106,7 +1106,7 @@ wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1140,7 +1140,7 @@ wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1177,7 +1177,7 @@ wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1, output2, filter=11, stat="pearson", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1, output2, filter=11, stat="pearson", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1221,7 +1221,7 @@ wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1 #' #' @return Returns the tool text outputs. #' @export -wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, standardize=FALSE, scattergram=FALSE, num_samples=1000, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, standardize=FALSE, scattergram=FALSE, num_samples=1000, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1265,7 +1265,7 @@ wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, sta #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1296,7 +1296,7 @@ wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compre #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1327,7 +1327,7 @@ wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1358,7 +1358,7 @@ wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1389,7 +1389,7 @@ wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_increment <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_increment <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1421,7 +1421,7 @@ wbt_increment <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1453,7 +1453,7 @@ wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1484,7 +1484,7 @@ wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1516,7 +1516,7 @@ wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1549,7 +1549,7 @@ wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1585,7 +1585,7 @@ wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1621,7 +1621,7 @@ wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1652,7 +1652,7 @@ wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1682,7 +1682,7 @@ wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_ln <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ln <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1713,7 +1713,7 @@ wbt_ln <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters= #' #' @return Returns the tool text outputs. #' @export -wbt_log10 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_log10 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1744,7 +1744,7 @@ wbt_log10 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_log2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_log2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1776,7 +1776,7 @@ wbt_log2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1809,7 +1809,7 @@ wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1842,7 +1842,7 @@ wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1875,7 +1875,7 @@ wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1907,7 +1907,7 @@ wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_negate <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_negate <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1939,7 +1939,7 @@ wbt_negate <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1973,7 +1973,7 @@ wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2009,7 +2009,7 @@ wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, w #' #' @return Returns the tool text outputs. #' @export -wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2042,7 +2042,7 @@ wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2076,7 +2076,7 @@ wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, standardized=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, standardized=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -2114,7 +2114,7 @@ wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, stan #' #' @return Returns the tool text outputs. #' @export -wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2148,7 +2148,7 @@ wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_random_field <- function(base, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_field <- function(base, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -2180,7 +2180,7 @@ wbt_random_field <- function(base, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -2214,7 +2214,7 @@ wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--output=", wbt_file_path(output))) @@ -2247,7 +2247,7 @@ wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2277,7 +2277,7 @@ wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2307,7 +2307,7 @@ wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2342,7 +2342,7 @@ wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, clip_min=NULL, clip_max=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, clip_min=NULL, clip_max=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2381,7 +2381,7 @@ wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, cli #' #' @return Returns the tool text outputs. #' @export -wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2412,7 +2412,7 @@ wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_round <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_round <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2443,7 +2443,7 @@ wbt_round <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2474,7 +2474,7 @@ wbt_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_sinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2505,7 +2505,7 @@ wbt_sinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_square <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_square <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2536,7 +2536,7 @@ wbt_square <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_square_root <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_square_root <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2568,7 +2568,7 @@ wbt_square_root <- function(input, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2600,7 +2600,7 @@ wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2631,7 +2631,7 @@ wbt_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_tanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2662,7 +2662,7 @@ wbt_tanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2693,7 +2693,7 @@ wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2725,7 +2725,7 @@ wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2762,7 +2762,7 @@ wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_trend_surface_vector_points <- function(input, field, output, cell_size, order=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_trend_surface_vector_points <- function(input, field, output, cell_size, order=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2799,7 +2799,7 @@ wbt_trend_surface_vector_points <- function(input, field, output, cell_size, ord #' #' @return Returns the tool text outputs. #' @export -wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2835,7 +2835,7 @@ wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -2872,7 +2872,7 @@ wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, w #' #' @return Returns the tool text outputs. #' @export -wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2909,7 +2909,7 @@ wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2945,7 +2945,7 @@ wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NU #' #' @return Returns the tool text outputs. #' @export -wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2977,7 +2977,7 @@ wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3011,7 +3011,7 @@ wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ra #' #' @return Returns the tool text outputs. #' @export -wbt_zonal_statistics <- function(input, features, output=NULL, stat="mean", out_table=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_zonal_statistics <- function(input, features, output=NULL, stat="mean", out_table=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/precision_agriculture.R b/PY2R/scripts/precision_agriculture.R index e2ca11c1f..bc7d03b5e 100644 --- a/PY2R/scripts/precision_agriculture.R +++ b/PY2R/scripts/precision_agriculture.R @@ -19,7 +19,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, output, radius=NULL, min_yield=NULL, max_yield=NULL, mean_tonnage=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, output, radius=NULL, min_yield=NULL, max_yield=NULL, mean_tonnage=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -68,7 +68,7 @@ wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, out #' #' @return Returns the tool text outputs. #' @export -wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, output_points, max_change_in_heading=25.0, ignore_zeros=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, output_points, max_change_in_heading=25.0, ignore_zeros=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -110,7 +110,7 @@ wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, outpu #' #' @return Returns the tool text outputs. #' @export -wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in_heading=25.0, flag_edges=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in_heading=25.0, flag_edges=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -156,7 +156,7 @@ wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in #' #' @return Returns the tool text outputs. #' @export -wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096, z_score_threshold=2.5, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096, z_score_threshold=2.5, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -204,7 +204,7 @@ wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096 #' #' @return Returns the tool text outputs. #' @export -wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_change_in_heading=25.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_change_in_heading=25.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -247,7 +247,7 @@ wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_chang #' #' @return Returns the tool text outputs. #' @export -wbt_yield_normalization <- function(input, yield_field, output, standardize=FALSE, radius=NULL, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_yield_normalization <- function(input, yield_field, output, standardize=FALSE, radius=NULL, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/PY2R/scripts/stream_network_analysis.R b/PY2R/scripts/stream_network_analysis.R index 58938dbe6..b2823354f 100644 --- a/PY2R/scripts/stream_network_analysis.R +++ b/PY2R/scripts/stream_network_analysis.R @@ -16,7 +16,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -56,7 +56,7 @@ wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, ze #' #' @return Returns the tool text outputs. #' @export -wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--flow_accum=", wbt_file_path(flow_accum))) @@ -94,7 +94,7 @@ wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=F #' #' @return Returns the tool text outputs. #' @export -wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filter=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filter=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -137,7 +137,7 @@ wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filte #' #' @return Returns the tool text outputs. #' @export -wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -178,7 +178,7 @@ wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -219,7 +219,7 @@ wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_b #' #' @return Returns the tool text outputs. #' @export -wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -260,7 +260,7 @@ wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' #' @return Returns the tool text outputs. #' @export -wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -301,7 +301,7 @@ wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, z #' #' @return Returns the tool text outputs. #' @export -wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -342,7 +342,7 @@ wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr= #' #' @return Returns the tool text outputs. #' @export -wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -381,7 +381,7 @@ wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -419,7 +419,7 @@ wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr #' #' @return Returns the tool text outputs. #' @export -wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--streams=", wbt_file_path(streams))) @@ -457,7 +457,7 @@ wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--streams=", wbt_file_path(streams))) @@ -498,7 +498,7 @@ wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id #' #' @return Returns the tool text outputs. #' @export -wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -535,7 +535,7 @@ wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_ #' #' @return Returns the tool text outputs. #' @export -wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -572,7 +572,7 @@ wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -613,7 +613,7 @@ wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -654,7 +654,7 @@ wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -695,7 +695,7 @@ wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -736,7 +736,7 @@ wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -778,7 +778,7 @@ wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zer #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -821,7 +821,7 @@ wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -863,7 +863,7 @@ wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr #' #' @return Returns the tool text outputs. #' @export -wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -904,7 +904,7 @@ wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -945,7 +945,7 @@ wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_vector_stream_network_analysis <- function(streams, dem, output, cutting_height=10.0, snap=0.1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_stream_network_analysis <- function(streams, dem, output, cutting_height=10.0, snap=0.1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--streams=", wbt_file_path(streams))) diff --git a/PY2R/scripts/terrain_analysis.R b/PY2R/scripts/terrain_analysis.R index c72529dee..8ac76499f 100644 --- a/PY2R/scripts/terrain_analysis.R +++ b/PY2R/scripts/terrain_analysis.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -53,7 +53,7 @@ wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -90,7 +90,7 @@ wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--routes=", wbt_file_path(routes))) @@ -129,7 +129,7 @@ wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -165,7 +165,7 @@ wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, #' #' @return Returns the tool text outputs. #' @export -wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -203,7 +203,7 @@ wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -243,7 +243,7 @@ wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, interval=10.0, base=0.0, smooth=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, interval=10.0, base=0.0, smooth=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -296,7 +296,7 @@ wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max #' #' @return Returns the tool text outputs. #' @export -wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smooth=9, tolerance=10.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smooth=9, tolerance=10.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -341,7 +341,7 @@ wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smo #' #' @return Returns the tool text outputs. #' @export -wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -382,7 +382,7 @@ wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_treatment="use DEM", weight_value=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_treatment="use DEM", weight_value=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -425,7 +425,7 @@ wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_tre #' #' @return Returns the tool text outputs. #' @export -wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -464,7 +464,7 @@ wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -503,7 +503,7 @@ wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -542,7 +542,7 @@ wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -581,7 +581,7 @@ wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -621,7 +621,7 @@ wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -661,7 +661,7 @@ wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -695,7 +695,7 @@ wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -735,7 +735,7 @@ wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits= #' #' @return Returns the tool text outputs. #' @export -wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -767,7 +767,7 @@ wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -808,7 +808,7 @@ wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_road_width=6.0, typical_width=30.0, max_height=2.0, max_width=60.0, max_increment=0.05, spillout_slope=4.0, remove_embankments=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_road_width=6.0, typical_width=30.0, max_height=2.0, max_width=60.0, max_increment=0.05, spillout_slope=4.0, remove_embankments=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -867,7 +867,7 @@ wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_r #' #' @return Returns the tool text outputs. #' @export -wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", zfactor="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", zfactor="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -912,7 +912,7 @@ wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", #' #' @return Returns the tool text outputs. #' @export -wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=15.0, num_iter=3, max_diff=0.5, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=15.0, num_iter=3, max_diff=0.5, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -960,7 +960,7 @@ wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=1 #' #' @return Returns the tool text outputs. #' @export -wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1000,7 +1000,7 @@ wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1041,7 +1041,7 @@ wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges #' #' @return Returns the tool text outputs. #' @export -wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1077,7 +1077,7 @@ wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1122,7 +1122,7 @@ wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, points=NULL, sigma=0.5, step=0.5, num_steps=10, lsp="Slope", z_factor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, points=NULL, sigma=0.5, step=0.5, num_steps=10, lsp="Slope", z_factor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1175,7 +1175,7 @@ wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, p #' #' @return Returns the tool text outputs. #' @export -wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1218,7 +1218,7 @@ wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip=0, forms=TRUE, residuals=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip=0, forms=TRUE, residuals=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1270,7 +1270,7 @@ wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip #' #' @return Returns the tool text outputs. #' @export -wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1312,7 +1312,7 @@ wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1351,7 +1351,7 @@ wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1389,7 +1389,7 @@ wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1431,7 +1431,7 @@ wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_weight=0.5, brightness=0.5, atmospheric=0.0, palette="atlas", reverse=FALSE, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_weight=0.5, brightness=0.5, atmospheric=0.0, palette="atlas", reverse=FALSE, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1491,7 +1491,7 @@ wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_ #' #' @return Returns the tool text outputs. #' @export -wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1536,7 +1536,7 @@ wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale= #' #' @return Returns the tool text outputs. #' @export -wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1572,7 +1572,7 @@ wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1613,7 +1613,7 @@ wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, #' #' @return Returns the tool text outputs. #' @export -wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale=3, step=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale=3, step=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1656,7 +1656,7 @@ wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale #' #' @return Returns the tool text outputs. #' @export -wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1696,7 +1696,7 @@ wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min #' #' @return Returns the tool text outputs. #' @export -wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1734,7 +1734,7 @@ wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1771,7 +1771,7 @@ wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max #' #' @return Returns the tool text outputs. #' @export -wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1806,7 +1806,7 @@ wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale, step=10, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale, step=10, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1847,7 +1847,7 @@ wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale #' #' @return Returns the tool text outputs. #' @export -wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1884,7 +1884,7 @@ wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_ #' #' @return Returns the tool text outputs. #' @export -wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1917,7 +1917,7 @@ wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1956,7 +1956,7 @@ wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1993,7 +1993,7 @@ wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2026,7 +2026,7 @@ wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2066,7 +2066,7 @@ wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2114,7 +2114,7 @@ wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=N #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out_scale=NULL, min_scale=0, step=1, num_steps=1, step_nonlinearity=1.0, log=TRUE, standardize=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out_scale=NULL, min_scale=0, step=1, num_steps=1, step_nonlinearity=1.0, log=TRUE, standardize=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2175,7 +2175,7 @@ wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_digits=3, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_digits=3, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2226,7 +2226,7 @@ wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_dig #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2269,7 +2269,7 @@ wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_sca #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2313,7 +2313,7 @@ wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, m #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2362,7 +2362,7 @@ wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2410,7 +2410,7 @@ wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_sc #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_topographic_position_image <- function(local, meso, broad, output, hillshade=NULL, lightness=1.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_topographic_position_image <- function(local, meso, broad, output, hillshade=NULL, lightness=1.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--local=", wbt_file_path(local))) @@ -2449,7 +2449,7 @@ wbt_multiscale_topographic_position_image <- function(local, meso, broad, output #' #' @return Returns the tool text outputs. #' @export -wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2480,7 +2480,7 @@ wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2513,7 +2513,7 @@ wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2552,7 +2552,7 @@ wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2597,7 +2597,7 @@ wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0. #' #' @return Returns the tool text outputs. #' @export -wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2636,7 +2636,7 @@ wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2674,7 +2674,7 @@ wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--lines=", wbt_file_path(lines))) @@ -2708,7 +2708,7 @@ wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2747,7 +2747,7 @@ wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2786,7 +2786,7 @@ wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2825,7 +2825,7 @@ wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=1 #' #' @return Returns the tool text outputs. #' @export -wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2864,7 +2864,7 @@ wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, w #' #' @return Returns the tool text outputs. #' @export -wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2903,7 +2903,7 @@ wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2940,7 +2940,7 @@ wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2974,7 +2974,7 @@ wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, slope_exponent=1.3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, slope_exponent=1.3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--sca=", wbt_file_path(sca))) @@ -3020,7 +3020,7 @@ wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, s #' #' @return Returns the tool text outputs. #' @export -wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", date="21/06/2021", interval=15, location="43.5448/-80.2482/-4", height=600, delay=250, label="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", date="21/06/2021", interval=15, location="43.5448/-80.2482/-4", height=600, delay=250, label="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3080,7 +3080,7 @@ wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", da #' #' @return Returns the tool text outputs. #' @export -wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="21/06/2021", time="13:00", location="43.5448/-80.2482/-4", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="21/06/2021", time="13:00", location="43.5448/-80.2482/-4", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3127,7 +3127,7 @@ wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="2 #' #' @return Returns the tool text outputs. #' @export -wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3163,7 +3163,7 @@ wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3203,7 +3203,7 @@ wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3244,7 +3244,7 @@ wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, #' #' @return Returns the tool text outputs. #' @export -wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -3281,7 +3281,7 @@ wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_threshold=1.0, scale_threshold=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_threshold=1.0, scale_threshold=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3322,7 +3322,7 @@ wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_thre #' #' @return Returns the tool text outputs. #' @export -wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3359,7 +3359,7 @@ wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3401,7 +3401,7 @@ wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx #' #' @return Returns the tool text outputs. #' @export -wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--sca=", wbt_file_path(sca))) @@ -3436,7 +3436,7 @@ wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3469,7 +3469,7 @@ wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3515,7 +3515,7 @@ wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_dist=100.0, utc_offset="00:00", start_day=1, end_day=365, start_time="00:00:00", end_time="23:59:59", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_dist=100.0, utc_offset="00:00", start_day=1, end_day=365, start_time="00:00:00", end_time="23:59:59", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3579,7 +3579,7 @@ wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_d #' #' @return Returns the tool text outputs. #' @export -wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=315.0, alt=30.0, background_hgt_offset=10.0, polygon=NULL, background_clr="[255, 255, 255]", attenuation=0.6, ambient_light=0.2, z_factor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=315.0, alt=30.0, background_hgt_offset=10.0, polygon=NULL, background_clr="[255, 255, 255]", attenuation=0.6, ambient_light=0.2, z_factor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3649,7 +3649,7 @@ wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=3 #' #' @return Returns the tool text outputs. #' @export -wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd", min_scale=1, num_steps=100, step_nonlinearity=1.5, height=600, delay=250, label="", dev_max=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd", min_scale=1, num_steps=100, step_nonlinearity=1.5, height=600, delay=250, label="", dev_max=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3706,7 +3706,7 @@ wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd" #' #' @return Returns the tool text outputs. #' @export -wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3745,7 +3745,7 @@ wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3784,7 +3784,7 @@ wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3823,7 +3823,7 @@ wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, w #' #' @return Returns the tool text outputs. #' @export -wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3860,7 +3860,7 @@ wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3898,7 +3898,7 @@ wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_wetness_index <- function(sca, slope, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_wetness_index <- function(sca, slope, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--sca=", wbt_file_path(sca))) diff --git a/PY2R/scripts/whitebox_utilities.R b/PY2R/scripts/whitebox_utilities.R index 68885e47d..5dd65f08a 100644 --- a/PY2R/scripts/whitebox_utilities.R +++ b/PY2R/scripts/whitebox_utilities.R @@ -12,7 +12,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_install_wb_extension <- function(install_extension="General Toolset Extension", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_install_wb_extension <- function(install_extension="General Toolset Extension", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (!is.null(install_extension)) { @@ -43,7 +43,7 @@ wbt_install_wb_extension <- function(install_extension="General Toolset Extensio #' #' @return Returns the tool text outputs. #' @export -wbt_launch_wb_runner <- function(clear_app_state=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_launch_wb_runner <- function(clear_app_state=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (clear_app_state) { diff --git a/R/data_tools.R b/R/data_tools.R index 0dfab8320..8c3cec1f7 100644 --- a/R/data_tools.R +++ b/R/data_tools.R @@ -12,7 +12,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -42,7 +42,7 @@ wbt_add_point_coordinates_to_table <- function(input, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -73,7 +73,7 @@ wbt_clean_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -104,7 +104,7 @@ wbt_convert_nodata_to_zero <- function(input, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -138,7 +138,7 @@ wbt_convert_raster_format <- function(input, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -179,7 +179,7 @@ wbt_csv_points_to_vector <- function(input, output, xfield=0, yfield=1, epsg=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -214,7 +214,7 @@ wbt_export_table_to_csv <- function(input, output, headers=TRUE, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -251,7 +251,7 @@ wbt_fix_dangling_arcs <- function(input, output, dist="", wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -287,7 +287,7 @@ wbt_join_tables <- function(input1, pkey, input2, fkey, import_field=NULL, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -321,7 +321,7 @@ wbt_lines_to_polygons <- function(input, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -357,7 +357,7 @@ wbt_merge_table_with_csv <- function(input, pkey, csv, fkey, import_field=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -388,7 +388,7 @@ wbt_merge_vectors <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -422,7 +422,7 @@ wbt_modify_no_data_value <- function(input, new_value="-32768.0", wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -459,7 +459,7 @@ wbt_multi_part_to_single_part <- function(input, output, exclude_holes=TRUE, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="float", cell_size=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="float", cell_size=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -499,7 +499,7 @@ wbt_new_raster_from_base <- function(base, output, value="nodata", data_type="fl #' #' @return Returns the tool text outputs. #' @export -wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -529,7 +529,7 @@ wbt_polygons_to_lines <- function(input, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -559,7 +559,7 @@ wbt_print_geo_tiff_tags <- function(input, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -590,7 +590,7 @@ wbt_raster_to_vector_lines <- function(input, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -621,7 +621,7 @@ wbt_raster_to_vector_points <- function(input, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -651,7 +651,7 @@ wbt_raster_to_vector_polygons <- function(input, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -681,7 +681,7 @@ wbt_reinitialize_attribute_table <- function(input, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -714,7 +714,7 @@ wbt_remove_polygon_holes <- function(input, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diagonals=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diagonals=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -752,7 +752,7 @@ wbt_remove_raster_polygon_holes <- function(input, output, threshold=3, use_diag #' #' @return Returns the tool text outputs. #' @export -wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -787,7 +787,7 @@ wbt_set_nodata_value <- function(input, output, back_value=0.0, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -825,7 +825,7 @@ wbt_single_part_to_multi_part <- function(input, output, field=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -873,7 +873,7 @@ wbt_vector_lines_to_raster <- function(input, output, field="FID", nodata=TRUE, #' #' @return Returns the tool text outputs. #' @export -wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -923,7 +923,7 @@ wbt_vector_points_to_raster <- function(input, output, field="FID", assign="last #' #' @return Returns the tool text outputs. #' @export -wbt_vector_polygons_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_polygons_to_raster <- function(input, output, field="FID", nodata=TRUE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/gis_analysis.R b/R/gis_analysis.R index 125282f0c..26e68c95f 100644 --- a/R/gis_analysis.R +++ b/R/gis_analysis.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -56,7 +56,7 @@ wbt_aggregate_raster <- function(input, output, agg_factor=2, type="mean", wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -101,7 +101,7 @@ wbt_block_maximum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' #' @return Returns the tool text outputs. #' @export -wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -143,7 +143,7 @@ wbt_block_minimum_gridding <- function(input, field, output, use_z=FALSE, cell_s #' #' @return Returns the tool text outputs. #' @export -wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -177,7 +177,7 @@ wbt_centroid <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -210,7 +210,7 @@ wbt_centroid_vector <- function(input, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -250,7 +250,7 @@ wbt_clump <- function(input, output, diag=TRUE, zero_back=FALSE, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -292,7 +292,7 @@ wbt_construct_vector_tin <- function(input, output, field=NULL, use_z=FALSE, max #' #' @return Returns the tool text outputs. #' @export -wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -330,7 +330,7 @@ wbt_create_hexagonal_vector_grid <- function(input, output, width, orientation=" #' #' @return Returns the tool text outputs. #' @export -wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -374,7 +374,7 @@ wbt_create_plane <- function(base, output, gradient=15.0, aspect=90.0, constant= #' #' @return Returns the tool text outputs. #' @export -wbt_create_rectangular_vector_grid <- function(input, output, width, height, xorig=0, yorig=0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_rectangular_vector_grid <- function(input, output, width, height, xorig=0, yorig=0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -415,7 +415,7 @@ wbt_create_rectangular_vector_grid <- function(input, output, width, height, xor #' #' @return Returns the tool text outputs. #' @export -wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -453,7 +453,7 @@ wbt_dissolve <- function(input, output, field=NULL, snap=0.0, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -487,7 +487,7 @@ wbt_eliminate_coincident_points <- function(input, output, tolerance, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -522,7 +522,7 @@ wbt_extend_vector_lines <- function(input, output, dist, extend="both ends", wd= #' #' @return Returns the tool text outputs. #' @export -wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -554,7 +554,7 @@ wbt_extract_nodes <- function(input, output, wd=NULL, verbose_mode=FALSE, compre #' #' @return Returns the tool text outputs. #' @export -wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -590,7 +590,7 @@ wbt_extract_raster_values_at_points <- function(inputs, points, out_text=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_filter_raster_features_by_area <- function(input, output, threshold, background="zero", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_raster_features_by_area <- function(input, output, threshold, background="zero", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -626,7 +626,7 @@ wbt_filter_raster_features_by_area <- function(input, output, threshold, backgro #' #' @return Returns the tool text outputs. #' @export -wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -665,7 +665,7 @@ wbt_find_lowest_or_highest_points <- function(input, output, out_type="lowest", #' #' @return Returns the tool text outputs. #' @export -wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel="quartic", cell_size="", base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel="quartic", cell_size="", base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -718,7 +718,7 @@ wbt_heat_map <- function(input, output, weight_field=NULL, bandwidth="", kernel= #' #' @return Returns the tool text outputs. #' @export -wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, radius=NULL, min_points=NULL, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, radius=NULL, min_points=NULL, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -768,7 +768,7 @@ wbt_idw_interpolation <- function(input, field, output, use_z=FALSE, weight=2.0, #' #' @return Returns the tool text outputs. #' @export -wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -799,7 +799,7 @@ wbt_layer_footprint <- function(input, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_medoid <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_medoid <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -832,7 +832,7 @@ wbt_medoid <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_bounding_box <- function(input, output, criterion="area", features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_bounding_box <- function(input, output, criterion="area", features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -870,7 +870,7 @@ wbt_minimum_bounding_box <- function(input, output, criterion="area", features=T #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -905,7 +905,7 @@ wbt_minimum_bounding_circle <- function(input, output, features=TRUE, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -940,7 +940,7 @@ wbt_minimum_bounding_envelope <- function(input, output, features=TRUE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -979,7 +979,7 @@ wbt_minimum_convex_hull <- function(input, output, features=TRUE, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z=FALSE, cell_size=NULL, base=NULL, clip=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z=FALSE, cell_size=NULL, base=NULL, clip=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1030,7 +1030,7 @@ wbt_natural_neighbour_interpolation <- function(input, output, field=NULL, use_z #' #' @return Returns the tool text outputs. #' @export -wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, max_dist=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, cell_size=NULL, base=NULL, max_dist=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1073,7 +1073,7 @@ wbt_nearest_neighbour_gridding <- function(input, field, output, use_z=FALSE, ce #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_area <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_area <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1103,7 +1103,7 @@ wbt_polygon_area <- function(input, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1133,7 +1133,7 @@ wbt_polygon_long_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1163,7 +1163,7 @@ wbt_polygon_perimeter <- function(input, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1203,7 +1203,7 @@ wbt_polygon_short_axis <- function(input, output, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_radial_basis_function_interpolation <- function(input, field, output, use_z=FALSE, radius=NULL, min_points=NULL, func_type="ThinPlateSpline", poly_order="none", weight=0.1, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_radial_basis_function_interpolation <- function(input, field, output, use_z=FALSE, radius=NULL, min_points=NULL, func_type="ThinPlateSpline", poly_order="none", weight=0.1, cell_size=NULL, base=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1262,7 +1262,7 @@ wbt_radial_basis_function_interpolation <- function(input, field, output, use_z= #' #' @return Returns the tool text outputs. #' @export -wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1305,7 +1305,7 @@ wbt_raster_area <- function(input, output=NULL, out_text=FALSE, units="grid cell #' #' @return Returns the tool text outputs. #' @export -wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1342,7 +1342,7 @@ wbt_raster_cell_assignment <- function(input, output, assign="column", wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid cells", zero_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1386,7 +1386,7 @@ wbt_raster_perimeter <- function(input, output=NULL, out_text=FALSE, units="grid #' #' @return Returns the tool text outputs. #' @export -wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1424,7 +1424,7 @@ wbt_reclass <- function(input, output, reclass_vals, assign_mode=FALSE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=NULL, end_val=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=NULL, end_val=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1465,7 +1465,7 @@ wbt_reclass_equal_interval <- function(input, output, interval=10.0, start_val=N #' #' @return Returns the tool text outputs. #' @export -wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1498,7 +1498,7 @@ wbt_reclass_from_file <- function(input, reclass_file, output, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1533,7 +1533,7 @@ wbt_smooth_vectors <- function(input, output, filter=3, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1572,7 +1572,7 @@ wbt_split_vector_lines <- function(input, output, length=NULL, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution=NULL, base=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution=NULL, base=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1619,7 +1619,7 @@ wbt_tin_gridding <- function(input, output, field=NULL, use_z=FALSE, resolution= #' #' @return Returns the tool text outputs. #' @export -wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1655,7 +1655,7 @@ wbt_travelling_salesman_problem <- function(input, output, duration=60, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1690,7 +1690,7 @@ wbt_vector_hex_binning <- function(input, output, width, orientation="horizontal #' #' @return Returns the tool text outputs. #' @export -wbt_voronoi_diagram <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_voronoi_diagram <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/gis_analysis_distance.R b/R/gis_analysis_distance.R index f91cbaf97..6fbf71845 100644 --- a/R/gis_analysis_distance.R +++ b/R/gis_analysis_distance.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -51,7 +51,7 @@ wbt_buffer_raster <- function(input, output, size, gridcells=FALSE, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--source=", wbt_file_path(source))) @@ -85,7 +85,7 @@ wbt_cost_allocation <- function(source, backlink, output, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--source=", wbt_file_path(source))) @@ -120,7 +120,7 @@ wbt_cost_distance <- function(source, cost, out_accum, out_backlink, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--destination=", wbt_file_path(destination))) @@ -155,7 +155,7 @@ wbt_cost_pathway <- function(destination, backlink, output, zero_background=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -186,7 +186,7 @@ wbt_euclidean_allocation <- function(input, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_euclidean_distance <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_euclidean_distance <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/gis_analysis_overlay.R b/R/gis_analysis_overlay.R index 03a2f1642..3be465fff 100644 --- a/R/gis_analysis_overlay.R +++ b/R/gis_analysis_overlay.R @@ -13,7 +13,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -45,7 +45,7 @@ wbt_average_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -79,7 +79,7 @@ wbt_clip <- function(input, clip, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensions=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensions=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -115,7 +115,7 @@ wbt_clip_raster_to_polygon <- function(input, polygons, output, maintain_dimensi #' #' @return Returns the tool text outputs. #' @export -wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -148,7 +148,7 @@ wbt_count_if <- function(inputs, output, value, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -181,7 +181,7 @@ wbt_difference <- function(input, overlay, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -214,7 +214,7 @@ wbt_erase <- function(input, erase, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -246,7 +246,7 @@ wbt_erase_polygon_from_raster <- function(input, polygons, output, wd=NULL, verb #' #' @return Returns the tool text outputs. #' @export -wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -279,7 +279,7 @@ wbt_highest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -315,7 +315,7 @@ wbt_intersect <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -347,7 +347,7 @@ wbt_line_intersections <- function(input1, input2, output, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -378,7 +378,7 @@ wbt_lowest_position <- function(inputs, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -409,7 +409,7 @@ wbt_max_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -441,7 +441,7 @@ wbt_max_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -475,7 +475,7 @@ wbt_merge_line_segments <- function(input, output, snap=0.0, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -506,7 +506,7 @@ wbt_min_absolute_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -537,7 +537,7 @@ wbt_min_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -569,7 +569,7 @@ wbt_multiply_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -602,7 +602,7 @@ wbt_percent_equal_to <- function(inputs, comparison, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -635,7 +635,7 @@ wbt_percent_greater_than <- function(inputs, comparison, output, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -668,7 +668,7 @@ wbt_percent_less_than <- function(inputs, comparison, output, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -700,7 +700,7 @@ wbt_pick_from_list <- function(inputs, pos_input, output, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -732,7 +732,7 @@ wbt_polygonize <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -764,7 +764,7 @@ wbt_split_with_lines <- function(input, split, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -797,7 +797,7 @@ wbt_sum_overlay <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -834,7 +834,7 @@ wbt_symmetrical_difference <- function(input, overlay, output, snap=0.0, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -870,7 +870,7 @@ wbt_union <- function(input, overlay, output, snap=0.0, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -906,7 +906,7 @@ wbt_update_nodata_cells <- function(input1, input2, output, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraints=NULL, scale_max=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraints=NULL, scale_max=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--factors=", wbt_file_path(factors))) @@ -948,7 +948,7 @@ wbt_weighted_overlay <- function(factors, weights, output, cost=NULL, constraint #' #' @return Returns the tool text outputs. #' @export -wbt_weighted_sum <- function(inputs, weights, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_weighted_sum <- function(inputs, weights, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) diff --git a/R/gis_analysis_patch_shape.R b/R/gis_analysis_patch_shape.R index 9aaece538..01e55ec3c 100644 --- a/R/gis_analysis_patch_shape.R +++ b/R/gis_analysis_patch_shape.R @@ -13,7 +13,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -43,7 +43,7 @@ wbt_boundary_shape_complexity <- function(input, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -74,7 +74,7 @@ wbt_compactness_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -107,7 +107,7 @@ wbt_edge_proportion <- function(input, output, output_text=FALSE, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -137,7 +137,7 @@ wbt_elongation_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_ra #' #' @return Returns the tool text outputs. #' @export -wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -167,7 +167,7 @@ wbt_find_patch_or_class_edge_cells <- function(input, output, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -196,7 +196,7 @@ wbt_hole_proportion <- function(input, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_linearity_index <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_linearity_index <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -226,7 +226,7 @@ wbt_linearity_index <- function(input, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -256,7 +256,7 @@ wbt_narrowness_index <- function(input, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -285,7 +285,7 @@ wbt_patch_orientation <- function(input, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -316,7 +316,7 @@ wbt_perimeter_area_ratio <- function(input, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -349,7 +349,7 @@ wbt_radius_of_gyration <- function(input, output, text_output=FALSE, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -378,7 +378,7 @@ wbt_related_circumscribing_circle <- function(input, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -408,7 +408,7 @@ wbt_shape_complexity_index <- function(input, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_shape_complexity_index_raster <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shape_complexity_index_raster <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/hydro_analysis.R b/R/hydro_analysis.R index c3012c83d..ef1712405 100644 --- a/R/hydro_analysis.R +++ b/R/hydro_analysis.R @@ -13,7 +13,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -44,7 +44,7 @@ wbt_average_flowpath_slope <- function(dem, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -76,7 +76,7 @@ wbt_average_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -114,7 +114,7 @@ wbt_basins <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, flat_increment=NULL, fill_pits=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, flat_increment=NULL, fill_pits=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -162,7 +162,7 @@ wbt_breach_depressions <- function(dem, output, max_depth=NULL, max_length=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, min_dist=TRUE, flat_increment=NULL, fill=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, min_dist=TRUE, flat_increment=NULL, fill=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -206,7 +206,7 @@ wbt_breach_depressions_least_cost <- function(dem, output, dist, max_cost=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -240,7 +240,7 @@ wbt_breach_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -281,7 +281,7 @@ wbt_burn_streams_at_roads <- function(dem, streams, roads, output, width=NULL, w #' #' @return Returns the tool text outputs. #' @export -wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -330,7 +330,7 @@ wbt_d8_flow_accumulation <- function(input, output, out_type="cells", log=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -365,7 +365,7 @@ wbt_d8_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -404,7 +404,7 @@ wbt_d8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contributing Area", threshold=NULL, log=FALSE, clip=FALSE, pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contributing Area", threshold=NULL, log=FALSE, clip=FALSE, pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -453,7 +453,7 @@ wbt_d_inf_flow_accumulation <- function(input, output, out_type="Specific Contri #' #' @return Returns the tool text outputs. #' @export -wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -487,7 +487,7 @@ wbt_d_inf_mass_flux <- function(dem, loading, efficiency, absorption, output, wd #' #' @return Returns the tool text outputs. #' @export -wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -519,7 +519,7 @@ wbt_d_inf_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -555,7 +555,7 @@ wbt_depth_in_sink <- function(dem, output, zero_background=FALSE, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -594,7 +594,7 @@ wbt_depth_to_water <- function(dem, output, streams=NULL, lakes=NULL, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -632,7 +632,7 @@ wbt_downslope_distance_to_stream <- function(dem, streams, output, dinf=FALSE, w #' #' @return Returns the tool text outputs. #' @export -wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weights=NULL, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weights=NULL, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -674,7 +674,7 @@ wbt_downslope_flowpath_length <- function(d8_pntr, output, watersheds=NULL, weig #' #' @return Returns the tool text outputs. #' @export -wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -712,7 +712,7 @@ wbt_edge_contamination <- function(dem, output, flow_type="mfd", zfactor="", wd= #' #' @return Returns the tool text outputs. #' @export -wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -745,7 +745,7 @@ wbt_elevation_above_stream <- function(dem, streams, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -782,7 +782,7 @@ wbt_elevation_above_stream_euclidean <- function(dem, streams, output, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -828,7 +828,7 @@ wbt_fd8_flow_accumulation <- function(dem, output, out_type="specific contributi #' #' @return Returns the tool text outputs. #' @export -wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -860,7 +860,7 @@ wbt_fd8_pointer <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -895,7 +895,7 @@ wbt_fill_burn <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, max_depth=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, max_depth=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -937,7 +937,7 @@ wbt_fill_depressions <- function(dem, output, fix_flats=TRUE, flat_increment=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -976,7 +976,7 @@ wbt_fill_depressions_planchon_and_darboux <- function(dem, output, fix_flats=TRU #' #' @return Returns the tool text outputs. #' @export -wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_increment=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1013,7 +1013,7 @@ wbt_fill_depressions_wang_and_liu <- function(dem, output, fix_flats=TRUE, flat_ #' #' @return Returns the tool text outputs. #' @export -wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1044,7 +1044,7 @@ wbt_fill_single_cell_pits <- function(dem, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1076,7 +1076,7 @@ wbt_find_no_flow_cells <- function(dem, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -1109,7 +1109,7 @@ wbt_find_parallel_flow <- function(d8_pntr, streams, output, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1141,7 +1141,7 @@ wbt_flatten_lakes <- function(dem, lakes, output, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1178,7 +1178,7 @@ wbt_flood_order <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accum, out_type="Specific Contributing Area", log=FALSE, clip=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accum, out_type="Specific Contributing Area", log=FALSE, clip=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1224,7 +1224,7 @@ wbt_flow_accumulation_full_workflow <- function(dem, out_dem, out_pntr, out_accu #' #' @return Returns the tool text outputs. #' @export -wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -1260,7 +1260,7 @@ wbt_flow_length_diff <- function(d8_pntr, output, esri_pntr=FALSE, wd=NULL, verb #' #' @return Returns the tool text outputs. #' @export -wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -1298,7 +1298,7 @@ wbt_hillslopes <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, threshold=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, threshold=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1341,7 +1341,7 @@ wbt_hydrologic_connectivity <- function(dem, output1, output2, exponent=1.0, thr #' #' @return Returns the tool text outputs. #' @export -wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NULL, out_volume=NULL, out_area=NULL, out_dam_height=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NULL, out_volume=NULL, out_area=NULL, out_dam_height=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1389,7 +1389,7 @@ wbt_impoundment_size_index <- function(dem, damlength, out_mean=NULL, out_max=NU #' #' @return Returns the tool text outputs. #' @export -wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1424,7 +1424,7 @@ wbt_insert_dams <- function(dem, dam_pts, output, damlength, wd=NULL, verbose_mo #' #' @return Returns the tool text outputs. #' @export -wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1461,7 +1461,7 @@ wbt_isobasins <- function(dem, output, size, connections=FALSE, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--pour_pts=", wbt_file_path(pour_pts))) @@ -1495,7 +1495,7 @@ wbt_jenson_snap_pour_points <- function(pour_pts, streams, output, snap_dist, wd #' #' @return Returns the tool text outputs. #' @export -wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1528,7 +1528,7 @@ wbt_longest_flowpath <- function(dem, basins, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1560,7 +1560,7 @@ wbt_low_points_on_headwater_divides <- function(dem, streams, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1592,7 +1592,7 @@ wbt_max_upslope_flowpath_length <- function(dem, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1629,7 +1629,7 @@ wbt_max_upslope_value <- function(dem, values, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.1, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1675,7 +1675,7 @@ wbt_md_inf_flow_accumulation <- function(dem, output, out_type="specific contrib #' #' @return Returns the tool text outputs. #' @export -wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1712,7 +1712,7 @@ wbt_num_inflowing_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=10.0, max_slope=45.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=10.0, max_slope=45.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1766,7 +1766,7 @@ wbt_qin_flow_accumulation <- function(dem, output, out_type="specific contributi #' #' @return Returns the tool text outputs. #' @export -wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contributing area", exponent=1.0, threshold=NULL, log=FALSE, clip=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1815,7 +1815,7 @@ wbt_quinn_flow_accumulation <- function(dem, output, out_type="specific contribu #' #' @return Returns the tool text outputs. #' @export -wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1858,7 +1858,7 @@ wbt_raise_walls <- function(input, dem, output, breach=NULL, height=100.0, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contributing area", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contributing area", log=FALSE, clip=FALSE, pntr=FALSE, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1905,7 +1905,7 @@ wbt_rho8_flow_accumulation <- function(input, output, out_type="specific contrib #' #' @return Returns the tool text outputs. #' @export -wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1941,7 +1941,7 @@ wbt_rho8_pointer <- function(dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1979,7 +1979,7 @@ wbt_river_centerlines <- function(input, output, min_length=3, radius=4, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2015,7 +2015,7 @@ wbt_sink <- function(input, output, zero_background=FALSE, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--pour_pts=", wbt_file_path(pour_pts))) @@ -2051,7 +2051,7 @@ wbt_snap_pour_points <- function(pour_pts, flow_accum, output, snap_dist, wd=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterations=100, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterations=100, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2089,7 +2089,7 @@ wbt_stochastic_depression_analysis <- function(dem, output, rmse, range, iterati #' #' @return Returns the tool text outputs. #' @export -wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -2126,7 +2126,7 @@ wbt_strahler_order_basins <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -2164,7 +2164,7 @@ wbt_subbasins <- function(d8_pntr, streams, output, esri_pntr=FALSE, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--seed_pts=", wbt_file_path(seed_pts))) @@ -2204,7 +2204,7 @@ wbt_trace_downslope_flowpaths <- function(seed_pts, d8_pntr, output, esri_pntr=F #' #' @return Returns the tool text outputs. #' @export -wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -2239,7 +2239,7 @@ wbt_unnest_basins <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2272,7 +2272,7 @@ wbt_upslope_depression_storage <- function(dem, output, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_watershed <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_watershed <- function(d8_pntr, pour_pts, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) diff --git a/R/image_analysis.R b/R/image_analysis.R index 525d1bd88..e5f37393d 100644 --- a/R/image_analysis.R +++ b/R/image_analysis.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--date1=", wbt_file_path(date1))) @@ -50,7 +50,7 @@ wbt_change_vector_analysis <- function(date1, date2, magnitude, direction, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -92,7 +92,7 @@ wbt_closing <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, enhance=TRUE, zeros=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, enhance=TRUE, zeros=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--red=", wbt_file_path(red))) @@ -135,7 +135,7 @@ wbt_create_colour_composite <- function(red, green, blue, output, opacity=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -174,7 +174,7 @@ wbt_flip_image <- function(input, output, direction="vertical", wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--intensity=", wbt_file_path(intensity))) @@ -226,7 +226,7 @@ wbt_ihs_to_rgb <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' #' @return Returns the tool text outputs. #' @export -wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=FALSE, label1="", palette2="grey", reverse2=FALSE, label2="", height=600, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=FALSE, label1="", palette2="grey", reverse2=FALSE, label2="", height=600, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -280,7 +280,7 @@ wbt_image_slider <- function(input1, input2, output, palette1="grey", reverse1=F #' #' @return Returns the tool text outputs. #' @export -wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -312,7 +312,7 @@ wbt_image_stack_profile <- function(inputs, points, output, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -343,7 +343,7 @@ wbt_integral_image <- function(input, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -375,7 +375,7 @@ wbt_line_thinning <- function(input, output, wd=NULL, verbose_mode=FALSE, compre #' #' @return Returns the tool text outputs. #' @export -wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--output=", wbt_file_path(output))) @@ -414,7 +414,7 @@ wbt_mosaic <- function(output, inputs=NULL, method="nn", wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weight=4.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weight=4.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -455,7 +455,7 @@ wbt_mosaic_with_feathering <- function(input1, input2, output, method="cc", weig #' #' @return Returns the tool text outputs. #' @export -wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, correction=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, correction=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -495,7 +495,7 @@ wbt_normalized_difference_index <- function(input1, input2, output, clip=0.0, co #' #' @return Returns the tool text outputs. #' @export -wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -533,7 +533,7 @@ wbt_opening <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -570,7 +570,7 @@ wbt_remove_spurs <- function(input, output, iterations=10, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -615,7 +615,7 @@ wbt_resample <- function(inputs, output, cell_size=NULL, base=NULL, method="cc", #' #' @return Returns the tool text outputs. #' @export -wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, composite=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blue=NULL, composite=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--intensity=", wbt_file_path(intensity))) @@ -661,7 +661,7 @@ wbt_rgb_to_ihs <- function(intensity, hue, saturation, red=NULL, green=NULL, blu #' #' @return Returns the tool text outputs. #' @export -wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -700,7 +700,7 @@ wbt_split_colour_composite <- function(input, red=NULL, green=NULL, blue=NULL, w #' #' @return Returns the tool text outputs. #' @export -wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -734,7 +734,7 @@ wbt_thicken_raster_line <- function(input, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant="white", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant="white", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -776,7 +776,7 @@ wbt_tophat_transform <- function(input, output, filterx=11, filtery=11, variant= #' #' @return Returns the tool text outputs. #' @export -wbt_write_function_memory_insertion <- function(input1, input2, output, input3=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_write_function_memory_insertion <- function(input1, input2, output, input3=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) diff --git a/R/image_analysis_classification.R b/R/image_analysis_classification.R index 2e28a22b9..e0040119b 100644 --- a/R/image_analysis_classification.R +++ b/R/image_analysis_classification.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -50,7 +50,7 @@ wbt_evaluate_training_sites <- function(inputs, polys, field, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_generalize_classified_raster <- function(input, output, min_size=4, method="longest", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_generalize_classified_raster <- function(input, output, min_size=4, method="longest", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -89,7 +89,7 @@ wbt_generalize_classified_raster <- function(input, output, min_size=4, method=" #' #' @return Returns the tool text outputs. #' @export -wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -127,7 +127,7 @@ wbt_generalize_with_similarity <- function(input, similarity, output, min_size=4 #' #' @return Returns the tool text outputs. #' @export -wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_area=4, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_area=4, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -170,7 +170,7 @@ wbt_image_segmentation <- function(inputs, output, threshold=0.5, steps=10, min_ #' #' @return Returns the tool text outputs. #' @export -wbt_min_dist_classification <- function(inputs, polys, field, output, threshold=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_dist_classification <- function(inputs, polys, field, output, threshold=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -208,7 +208,7 @@ wbt_min_dist_classification <- function(inputs, polys, field, output, threshold= #' #' @return Returns the tool text outputs. #' @export -wbt_parallelepiped_classification <- function(inputs, polys, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_parallelepiped_classification <- function(inputs, polys, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) diff --git a/R/image_analysis_enhancement.R b/R/image_analysis_enhancement.R index a43ce07f3..7ebce27ef 100644 --- a/R/image_analysis_enhancement.R +++ b/R/image_analysis_enhancement.R @@ -14,7 +14,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -52,7 +52,7 @@ wbt_balance_contrast_enhancement <- function(input, output, band_mean=100.0, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_width=228.6, n=4.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_width=228.6, n=4.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -95,7 +95,7 @@ wbt_correct_vignetting <- function(input, pp, output, focal_length=304.8, image_ #' #' @return Returns the tool text outputs. #' @export -wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -133,7 +133,7 @@ wbt_direct_decorrelation_stretch <- function(input, output, k=0.5, clip=1.0, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -168,7 +168,7 @@ wbt_gamma_correction <- function(input, output, gamma=0.5, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -203,7 +203,7 @@ wbt_gaussian_contrast_stretch <- function(input, output, num_tones=256, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -238,7 +238,7 @@ wbt_histogram_equalization <- function(input, output, num_tones=256, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -271,7 +271,7 @@ wbt_histogram_matching <- function(input, histo_file, output, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -306,7 +306,7 @@ wbt_histogram_matching_two_images <- function(input1, input2, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -347,7 +347,7 @@ wbt_min_max_contrast_stretch <- function(input, output, min_val, max_val, num_to #' #' @return Returns the tool text outputs. #' @export -wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue=NULL, composite=NULL, method="brovey", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue=NULL, composite=NULL, method="brovey", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--pan=", wbt_file_path(pan))) @@ -396,7 +396,7 @@ wbt_panchromatic_sharpening <- function(pan, output, red=NULL, green=NULL, blue= #' #' @return Returns the tool text outputs. #' @export -wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both", num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both", num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -438,7 +438,7 @@ wbt_percentage_contrast_stretch <- function(input, output, clip=1.0, tail="both" #' #' @return Returns the tool text outputs. #' @export -wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -478,7 +478,7 @@ wbt_piecewise_contrast_stretch <- function(input, output, FUN="", greytones=1024 #' #' @return Returns the tool text outputs. #' @export -wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -520,7 +520,7 @@ wbt_sigmoidal_contrast_stretch <- function(input, output, cutoff=0.0, gain=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_standard_deviation_contrast_stretch <- function(input, output, stdev=2.0, num_tones=256, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_standard_deviation_contrast_stretch <- function(input, output, stdev=2.0, num_tones=256, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/image_analysis_filters.R b/R/image_analysis_filters.R index 4297acb98..f7e4a2af4 100644 --- a/R/image_analysis_filters.R +++ b/R/image_analysis_filters.R @@ -16,7 +16,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -58,7 +58,7 @@ wbt_adaptive_filter <- function(input, output, filterx=11, filtery=11, threshold #' #' @return Returns the tool text outputs. #' @export -wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -99,7 +99,7 @@ wbt_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0.15, add_back=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0.15, add_back=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -144,7 +144,7 @@ wbt_canny_edge_detection <- function(input, output, sigma=0.5, low=0.05, high=0. #' #' @return Returns the tool text outputs. #' @export -wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -181,7 +181,7 @@ wbt_conservative_smoothing_filter <- function(input, output, filterx=3, filtery= #' #' @return Returns the tool text outputs. #' @export -wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -214,7 +214,7 @@ wbt_corner_detection <- function(input, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -253,7 +253,7 @@ wbt_diff_of_gaussian_filter <- function(input, output, sigma1=2.0, sigma2=4.0, w #' #' @return Returns the tool text outputs. #' @export -wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -292,7 +292,7 @@ wbt_diversity_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -329,7 +329,7 @@ wbt_edge_preserving_mean_filter <- function(input, output, threshold, filter=11, #' #' @return Returns the tool text outputs. #' @export -wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -367,7 +367,7 @@ wbt_emboss_filter <- function(input, output, direction="n", clip=0.0, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -402,7 +402,7 @@ wbt_fast_almost_gaussian_filter <- function(input, output, sigma=1.8, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -438,7 +438,7 @@ wbt_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma_int=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -477,7 +477,7 @@ wbt_high_pass_bilateral_filter <- function(input, output, sigma_dist=0.75, sigma #' #' @return Returns the tool text outputs. #' @export -wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -517,7 +517,7 @@ wbt_high_pass_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -560,7 +560,7 @@ wbt_high_pass_median_filter <- function(input, output, filterx=11, filtery=11, s #' #' @return Returns the tool text outputs. #' @export -wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -602,7 +602,7 @@ wbt_k_nearest_mean_filter <- function(input, output, filterx=11, filtery=11, k=5 #' #' @return Returns the tool text outputs. #' @export -wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -640,7 +640,7 @@ wbt_laplacian_filter <- function(input, output, variant="3x3(1)", clip=0.0, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -678,7 +678,7 @@ wbt_laplacian_of_gaussian_filter <- function(input, output, sigma=0.75, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10.0, m=5.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10.0, m=5.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -724,7 +724,7 @@ wbt_lee_sigma_filter <- function(input, output, filterx=11, filtery=11, sigma=10 #' #' @return Returns the tool text outputs. #' @export -wbt_line_detection_filter <- function(input, output, variant="vertical", absvals=FALSE, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_line_detection_filter <- function(input, output, variant="vertical", absvals=FALSE, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -766,7 +766,7 @@ wbt_line_detection_filter <- function(input, output, variant="vertical", absvals #' #' @return Returns the tool text outputs. #' @export -wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -805,7 +805,7 @@ wbt_majority_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -844,7 +844,7 @@ wbt_maximum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -884,7 +884,7 @@ wbt_mean_filter <- function(input, output, filterx=3, filtery=3, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -926,7 +926,7 @@ wbt_median_filter <- function(input, output, filterx=11, filtery=11, sig_digits= #' #' @return Returns the tool text outputs. #' @export -wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -965,7 +965,7 @@ wbt_minimum_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1005,7 +1005,7 @@ wbt_olympic_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1046,7 +1046,7 @@ wbt_percentile_filter <- function(input, output, filterx=11, filtery=11, sig_dig #' #' @return Returns the tool text outputs. #' @export -wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1082,7 +1082,7 @@ wbt_prewitt_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1120,7 +1120,7 @@ wbt_range_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1155,7 +1155,7 @@ wbt_roberts_cross_filter <- function(input, output, clip=0.0, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1191,7 +1191,7 @@ wbt_scharr_filter <- function(input, output, clip=0.0, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1230,7 +1230,7 @@ wbt_sobel_filter <- function(input, output, variant="3x3", clip=0.0, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1269,7 +1269,7 @@ wbt_standard_deviation_filter <- function(input, output, filterx=11, filtery=11, #' #' @return Returns the tool text outputs. #' @export -wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1309,7 +1309,7 @@ wbt_total_filter <- function(input, output, filterx=11, filtery=11, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, threshold=0.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, threshold=0.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1352,7 +1352,7 @@ wbt_unsharp_masking <- function(input, output, sigma=0.75, amount=100.0, thresho #' #' @return Returns the tool text outputs. #' @export -wbt_user_defined_weights_filter <- function(input, weights, output, center="center", normalize=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_user_defined_weights_filter <- function(input, weights, output, center="center", normalize=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/lidar_analysis.R b/R/lidar_analysis.R index 7e32d6bdf..ff6d936ee 100644 --- a/R/lidar_analysis.R +++ b/R/lidar_analysis.R @@ -14,7 +14,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -49,7 +49,7 @@ wbt_ascii_to_las <- function(inputs, pattern, proj=NULL, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -88,7 +88,7 @@ wbt_classify_buildings_in_lidar <- function(input, buildings, output, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1, oto_threshold=2.0, planarity_threshold=0.85, linearity_threshold=0.70, iterations=30, facade_threshold=0.5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1, oto_threshold=2.0, planarity_threshold=0.85, linearity_threshold=0.70, iterations=30, facade_threshold=0.5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -145,7 +145,7 @@ wbt_classify_lidar <- function(input, output=NULL, radius=1.5, grd_threshold=0.1 #' #' @return Returns the tool text outputs. #' @export -wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion="max scan angle", filter=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion="max scan angle", filter=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -186,7 +186,7 @@ wbt_classify_overlap_points <- function(input, output, resolution=2.0, criterion #' #' @return Returns the tool text outputs. #' @export -wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -222,7 +222,7 @@ wbt_clip_lidar_to_polygon <- function(input, polygons, output, wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending=50.0, clr_str="", use_unique_clrs_for_buildings=FALSE, radius="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending=50.0, clr_str="", use_unique_clrs_for_buildings=FALSE, radius="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -272,7 +272,7 @@ wbt_colourize_based_on_class <- function(input, output=NULL, intensity_blending= #' #' @return Returns the tool text outputs. #' @export -wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_blending=50.0, only="(230,214,170)", first="(0,140,0)", intermediate="(255,0,255)", last="(0,0,255)", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_blending=50.0, only="(230,214,170)", first="(0,140,0)", intermediate="(255,0,255)", last="(0,0,255)", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -325,7 +325,7 @@ wbt_colourize_based_on_point_returns <- function(input, output=NULL, intensity_b #' #' @return Returns the tool text outputs. #' @export -wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -358,7 +358,7 @@ wbt_erase_polygon_from_lidar <- function(input, polygons, output, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -395,7 +395,7 @@ wbt_filter_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -430,7 +430,7 @@ wbt_filter_lidar_classes <- function(input, output, exclude_cls=NULL, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -462,7 +462,7 @@ wbt_filter_lidar_scan_angles <- function(input, output, threshold, wd=NULL, verb #' #' @return Returns the tool text outputs. #' @export -wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -494,7 +494,7 @@ wbt_find_flightline_edge_points <- function(input, output, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -530,7 +530,7 @@ wbt_flightline_overlap <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -568,7 +568,7 @@ wbt_height_above_ground <- function(input, output=NULL, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius=1.0, min_height=0.0, max_search_radius="", max_height="", only_use_veg=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius=1.0, min_height=0.0, max_search_radius="", max_height="", only_use_veg=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -615,7 +615,7 @@ wbt_individual_tree_detection <- function(input, output=NULL, min_search_radius= #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -645,7 +645,7 @@ wbt_las_to_ascii <- function(inputs, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -677,7 +677,7 @@ wbt_las_to_laz <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -706,7 +706,7 @@ wbt_las_to_multipoint_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -738,7 +738,7 @@ wbt_las_to_shapefile <- function(input, wd=NULL, verbose_mode=FALSE, compress_ra #' #' @return Returns the tool text outputs. #' @export -wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (!is.null(inputs)) { @@ -779,7 +779,7 @@ wbt_las_to_zlidar <- function(inputs=NULL, outdir=NULL, compress="brotli", level #' #' @return Returns the tool text outputs. #' @export -wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -813,7 +813,7 @@ wbt_laz_to_las <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -850,7 +850,7 @@ wbt_lidar_block_maximum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -889,7 +889,7 @@ wbt_lidar_block_minimum <- function(input, output=NULL, resolution=1.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsubset_class=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsubset_class=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -926,7 +926,7 @@ wbt_lidar_classify_subset <- function(base, subset, output, subset_class, nonsub #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--in_lidar=", wbt_file_path(in_lidar))) @@ -967,7 +967,7 @@ wbt_lidar_colourize <- function(in_lidar, in_image, output, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smooth=5, parameter="elevation", returns="all", exclude_cls=NULL, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smooth=5, parameter="elevation", returns="all", exclude_cls=NULL, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1032,7 +1032,7 @@ wbt_lidar_contour <- function(input, output=NULL, interval=10.0, base=0.0, smoot #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, radius=0.5, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, radius=0.5, minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1081,7 +1081,7 @@ wbt_lidar_digital_surface_model <- function(input, output=NULL, resolution=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1122,7 +1122,7 @@ wbt_lidar_eigenvalue_features <- function(input, num_neighbours=NULL, radius=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=FALSE, inclassval=2, outclassval=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=FALSE, inclassval=2, outclassval=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1175,7 +1175,7 @@ wbt_lidar_elevation_slice <- function(input, output, minz=NULL, maxz=NULL, cls=F #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbours=0, slope_threshold=45.0, height_threshold=1.0, classify=TRUE, slope_norm=TRUE, height_above_ground=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbours=0, slope_threshold=45.0, height_threshold=1.0, classify=TRUE, slope_norm=TRUE, height_above_ground=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1229,7 +1229,7 @@ wbt_lidar_ground_point_filter <- function(input, output, radius=2.0, min_neighbo #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1267,7 +1267,7 @@ wbt_lidar_hex_binning <- function(input, output, width, orientation="horizontal" #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, radius=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, radius=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1309,7 +1309,7 @@ wbt_lidar_hillshade <- function(input, output, azimuth=315.0, altitude=30.0, rad #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1354,7 +1354,7 @@ wbt_lidar_histogram <- function(input, output, parameter="elevation", clip=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, weight=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, weight=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1414,7 +1414,7 @@ wbt_lidar_idw_interpolation <- function(input, output=NULL, parameter="elevation #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1454,7 +1454,7 @@ wbt_lidar_info <- function(input, output, density=TRUE, vlr=TRUE, geokeys=TRUE, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1488,7 +1488,7 @@ wbt_lidar_join <- function(inputs, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolution=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolution=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1531,7 +1531,7 @@ wbt_lidar_kappa_index <- function(input1, input2, output, class_accuracy, resolu #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1591,7 +1591,7 @@ wbt_lidar_nearest_neighbour_gridding <- function(input, output=NULL, parameter=" #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolution=1.0, radius=2.5, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1642,7 +1642,7 @@ wbt_lidar_point_density <- function(input, output=NULL, returns="all", resolutio #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1681,7 +1681,7 @@ wbt_lidar_point_return_analysis <- function(input, output=NULL, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pulses=FALSE, avg_points_per_pulse=TRUE, z_range=FALSE, intensity_range=FALSE, predom_class=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pulses=FALSE, avg_points_per_pulse=TRUE, z_range=FALSE, intensity_range=FALSE, predom_class=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1740,7 +1740,7 @@ wbt_lidar_point_stats <- function(input, resolution=1.0, num_points=TRUE, num_pu #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_samples=5, threshold=0.35, model_size=8, max_slope=80.0, classify=FALSE, last_returns=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_samples=5, threshold=0.35, model_size=8, max_slope=80.0, classify=FALSE, last_returns=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1805,7 +1805,7 @@ wbt_lidar_ransac_planes <- function(input, output, radius=2.0, num_iter=50, num_ #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, num_points=20, exclude_cls=NULL, minz=NULL, maxz=NULL, func_type="ThinPlateSpline", poly_order="none", weight=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, num_points=20, exclude_cls=NULL, minz=NULL, maxz=NULL, func_type="ThinPlateSpline", poly_order="none", weight=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1869,7 +1869,7 @@ wbt_lidar_rbf_interpolation <- function(input, output=NULL, parameter="elevation #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1907,7 +1907,7 @@ wbt_lidar_remove_duplicates <- function(input, output, include_z=FALSE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, use_median=FALSE, classify=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, use_median=FALSE, classify=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1960,7 +1960,7 @@ wbt_lidar_remove_outliers <- function(input, output, radius=2.0, elev_diff=50.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=65.0, norm_diff=10.0, azimuth=180.0, altitude=30.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=65.0, norm_diff=10.0, azimuth=180.0, altitude=30.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--buildings=", wbt_file_path(buildings))) @@ -2031,7 +2031,7 @@ wbt_lidar_rooftop_analysis <- function(buildings, output, input=NULL, radius=2.0 #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=80.0, norm_diff=10.0, maxzdiff=1.0, classes=FALSE, ground=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=80.0, norm_diff=10.0, maxzdiff=1.0, classes=FALSE, ground=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2096,7 +2096,7 @@ wbt_lidar_segmentation <- function(input, output, radius=2.0, num_iter=50, num_s #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_diff=2.0, maxzdiff=1.0, classify=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_diff=2.0, maxzdiff=1.0, classify=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2142,7 +2142,7 @@ wbt_lidar_segmentation_based_filter <- function(input, output, radius=5.0, norm_ #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2188,7 +2188,7 @@ wbt_lidar_shift <- function(input, output, x_shift="", y_shift="", z_shift="", w #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls=NULL, minz=NULL, maxz=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2239,7 +2239,7 @@ wbt_lidar_sibson_interpolation <- function(input, output=NULL, parameter="elevat #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2273,7 +2273,7 @@ wbt_lidar_sort_by_time <- function(input, output, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_filtered=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_filtered=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2316,7 +2316,7 @@ wbt_lidar_thin <- function(input, output, resolution=2.0, method="lowest", save_ #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, save_filtered=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, save_filtered=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2358,7 +2358,7 @@ wbt_lidar_thin_high_density <- function(input, output, density, resolution=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, origin_y=0.0, min_points=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, origin_y=0.0, min_points=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2404,7 +2404,7 @@ wbt_lidar_tile <- function(input, width=1000.0, height=1000.0, origin_x=0.0, ori #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2445,7 +2445,7 @@ wbt_lidar_tile_footprint <- function(input, output, hull=FALSE, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls="7,18", minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", returns="all", resolution=1.0, exclude_cls="7,18", minz=NULL, maxz=NULL, max_triangle_edge_length=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2500,7 +2500,7 @@ wbt_lidar_tin_gridding <- function(input, output=NULL, parameter="elevation", re #' #' @return Returns the tool text outputs. #' @export -wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2535,7 +2535,7 @@ wbt_lidar_tophat_transform <- function(input, output, radius=1.0, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2572,7 +2572,7 @@ wbt_modify_lidar <- function(input, output=NULL, statement="", wd=NULL, verbose_ #' #' @return Returns the tool text outputs. #' @export -wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2607,7 +2607,7 @@ wbt_normal_vectors <- function(input, output, radius=1.0, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2643,7 +2643,7 @@ wbt_normalize_lidar <- function(input, output, dtm, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src_id=FALSE, user_data=FALSE, rgb=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src_id=FALSE, user_data=FALSE, rgb=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2687,7 +2687,7 @@ wbt_recover_flightline_info <- function(input, output, max_time_diff=5.0, pt_src #' #' @return Returns the tool text outputs. #' @export -wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--indir=", wbt_file_path(indir))) @@ -2720,7 +2720,7 @@ wbt_select_tiles_by_polygon <- function(indir, outdir, polygons, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2758,7 +2758,7 @@ wbt_sort_lidar <- function(input, output=NULL, criteria="", wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2797,7 +2797,7 @@ wbt_split_lidar <- function(input, criterion="num_pts", interval="", min_pts=5, #' #' @return Returns the tool text outputs. #' @export -wbt_zlidar_to_las <- function(inputs=NULL, outdir=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_zlidar_to_las <- function(inputs=NULL, outdir=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (!is.null(inputs)) { diff --git a/R/machine_learning.R b/R/machine_learning.R index e4835cd4b..76327f5b5 100644 --- a/R/machine_learning.R +++ b/R/machine_learning.R @@ -16,7 +16,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, min_points=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, min_points=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -62,7 +62,7 @@ wbt_dbscan <- function(inputs, output, scaling="Normalize", search_dist=0.01, mi #' #' @return Returns the tool text outputs. #' @export -wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_iterations=10, class_change=2.0, initialize="diagonal", min_class_size=10, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_iterations=10, class_change=2.0, initialize="diagonal", min_class_size=10, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -115,7 +115,7 @@ wbt_k_means_clustering <- function(inputs, output, classes, out_html=NULL, max_i #' #' @return Returns the tool text outputs. #' @export -wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, clip=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, clip=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -168,7 +168,7 @@ wbt_knn_classification <- function(inputs, training, field, scaling="Normalize", #' #' @return Returns the tool text outputs. #' @export -wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, weight=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, k=5, weight=TRUE, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -219,7 +219,7 @@ wbt_knn_regression <- function(inputs, training, field, scaling="Normalize", out #' #' @return Returns the tool text outputs. #' @export -wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -265,7 +265,7 @@ wbt_logistic_regression <- function(inputs, training, field, scaling="Normalize" #' #' @return Returns the tool text outputs. #' @export -wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start_clusters=1000, merge_dist=NULL, max_iterations=10, class_change=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start_clusters=1000, merge_dist=NULL, max_iterations=10, class_change=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -318,7 +318,7 @@ wbt_modified_k_means_clustering <- function(inputs, output, out_html=NULL, start #' #' @return Returns the tool text outputs. #' @export -wbt_random_forest_classification <- function(inputs, training, field, output=NULL, split_criterion="Gini", n_trees=500, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_forest_classification <- function(inputs, training, field, output=NULL, split_criterion="Gini", n_trees=500, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -374,7 +374,7 @@ wbt_random_forest_classification <- function(inputs, training, field, output=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n_trees=100, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n_trees=100, min_samples_leaf=1, min_samples_split=2, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -428,7 +428,7 @@ wbt_random_forest_regression <- function(inputs, training, field, output=NULL, n #' #' @return Returns the tool text outputs. #' @export -wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, c=200.0, gamma=50.0, tolerance=0.1, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", output=NULL, c=200.0, gamma=50.0, tolerance=0.1, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -485,7 +485,7 @@ wbt_svm_classification <- function(inputs, training, field, scaling="Normalize", #' #' @return Returns the tool text outputs. #' @export -wbt_svm_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, c=50.0, eps=10.0, gamma=0.5, test_proportion=0.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_svm_regression <- function(inputs, training, field, scaling="Normalize", output=NULL, c=50.0, eps=10.0, gamma=0.5, test_proportion=0.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) diff --git a/R/math_stat_analysis.R b/R/math_stat_analysis.R index 1e6c88f4e..a8fa5e57a 100644 --- a/R/math_stat_analysis.R +++ b/R/math_stat_analysis.R @@ -14,7 +14,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -47,7 +47,7 @@ wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -80,7 +80,7 @@ wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -112,7 +112,7 @@ wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -144,7 +144,7 @@ wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -177,7 +177,7 @@ wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -209,7 +209,7 @@ wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -240,7 +240,7 @@ wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -271,7 +271,7 @@ wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -302,7 +302,7 @@ wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ras #' #' @return Returns the tool text outputs. #' @export -wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -333,7 +333,7 @@ wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -364,7 +364,7 @@ wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_artanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_artanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -396,7 +396,7 @@ wbt_artanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input_y=", wbt_file_path(input_y))) @@ -428,7 +428,7 @@ wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -465,7 +465,7 @@ wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, field2, radius=NULL, min_points=NULL, stat="pearson", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, field2, radius=NULL, min_points=NULL, stat="pearson", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -507,7 +507,7 @@ wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, fiel #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -542,7 +542,7 @@ wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -578,7 +578,7 @@ wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=F #' #' @return Returns the tool text outputs. #' @export -wbt_ceil <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ceil <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -612,7 +612,7 @@ wbt_ceil <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, false=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, false=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -661,7 +661,7 @@ wbt_conditional_evaluation <- function(input, output, statement="", true=NULL, f #' #' @return Returns the tool text outputs. #' @export -wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterations=25000, seed=NULL, prob=0.5, threshold=NULL, temp=1.0, temp_decay=0.05, cycle=10, average=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterations=25000, seed=NULL, prob=0.5, threshold=NULL, temp=1.0, temp_decay=0.05, cycle=10, average=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -719,7 +719,7 @@ wbt_conditioned_latin_hypercube <- function(inputs, output, samples=500, iterati #' #' @return Returns the tool text outputs. #' @export -wbt_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cos <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -750,7 +750,7 @@ wbt_cos <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_cosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cosh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -781,7 +781,7 @@ wbt_cosh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -815,7 +815,7 @@ wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -847,7 +847,7 @@ wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -878,7 +878,7 @@ wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_decrement <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_decrement <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -910,7 +910,7 @@ wbt_decrement <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -943,7 +943,7 @@ wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -975,7 +975,7 @@ wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_exp <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_exp <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1006,7 +1006,7 @@ wbt_exp <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1037,7 +1037,7 @@ wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_floor <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_floor <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1070,7 +1070,7 @@ wbt_floor <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1106,7 +1106,7 @@ wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1140,7 +1140,7 @@ wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1177,7 +1177,7 @@ wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1, output2, filter=11, stat="pearson", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1, output2, filter=11, stat="pearson", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1221,7 +1221,7 @@ wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1 #' #' @return Returns the tool text outputs. #' @export -wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, standardize=FALSE, scattergram=FALSE, num_samples=1000, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, standardize=FALSE, scattergram=FALSE, num_samples=1000, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1265,7 +1265,7 @@ wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, sta #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1296,7 +1296,7 @@ wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compre #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1327,7 +1327,7 @@ wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1358,7 +1358,7 @@ wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1389,7 +1389,7 @@ wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_increment <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_increment <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1421,7 +1421,7 @@ wbt_increment <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_r #' #' @return Returns the tool text outputs. #' @export -wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1453,7 +1453,7 @@ wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1484,7 +1484,7 @@ wbt_inverse_principal_component_analysis <- function(inputs, report, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1516,7 +1516,7 @@ wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1549,7 +1549,7 @@ wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1585,7 +1585,7 @@ wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1621,7 +1621,7 @@ wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1652,7 +1652,7 @@ wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1682,7 +1682,7 @@ wbt_list_unique_values_raster <- function(input, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_ln <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ln <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1713,7 +1713,7 @@ wbt_ln <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters= #' #' @return Returns the tool text outputs. #' @export -wbt_log10 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_log10 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1744,7 +1744,7 @@ wbt_log10 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_log2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_log2 <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1776,7 +1776,7 @@ wbt_log2 <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1809,7 +1809,7 @@ wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1842,7 +1842,7 @@ wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1875,7 +1875,7 @@ wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, comp #' #' @return Returns the tool text outputs. #' @export -wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1907,7 +1907,7 @@ wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_negate <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_negate <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1939,7 +1939,7 @@ wbt_negate <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -1973,7 +1973,7 @@ wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2009,7 +2009,7 @@ wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, w #' #' @return Returns the tool text outputs. #' @export -wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2042,7 +2042,7 @@ wbt_phi_coefficient <- function(input1, input2, output, wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2076,7 +2076,7 @@ wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, standardized=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, standardized=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -2114,7 +2114,7 @@ wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, stan #' #' @return Returns the tool text outputs. #' @export -wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2148,7 +2148,7 @@ wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_random_field <- function(base, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_field <- function(base, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -2180,7 +2180,7 @@ wbt_random_field <- function(base, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -2214,7 +2214,7 @@ wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_m #' #' @return Returns the tool text outputs. #' @export -wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--output=", wbt_file_path(output))) @@ -2247,7 +2247,7 @@ wbt_raster_calculator <- function(output, statement="", wd=NULL, verbose_mode=FA #' #' @return Returns the tool text outputs. #' @export -wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2277,7 +2277,7 @@ wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2307,7 +2307,7 @@ wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2342,7 +2342,7 @@ wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, clip_min=NULL, clip_max=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, clip_min=NULL, clip_max=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2381,7 +2381,7 @@ wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, cli #' #' @return Returns the tool text outputs. #' @export -wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2412,7 +2412,7 @@ wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_round <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_round <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2443,7 +2443,7 @@ wbt_round <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raste #' #' @return Returns the tool text outputs. #' @export -wbt_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sin <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2474,7 +2474,7 @@ wbt_sin <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_sinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sinh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2505,7 +2505,7 @@ wbt_sinh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_square <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_square <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2536,7 +2536,7 @@ wbt_square <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rast #' #' @return Returns the tool text outputs. #' @export -wbt_square_root <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_square_root <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2568,7 +2568,7 @@ wbt_square_root <- function(input, output, wd=NULL, verbose_mode=FALSE, compress #' #' @return Returns the tool text outputs. #' @export -wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2600,7 +2600,7 @@ wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, co #' #' @return Returns the tool text outputs. #' @export -wbt_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tan <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2631,7 +2631,7 @@ wbt_tan <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters #' #' @return Returns the tool text outputs. #' @export -wbt_tanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tanh <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2662,7 +2662,7 @@ wbt_tanh <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_raster #' #' @return Returns the tool text outputs. #' @export -wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2693,7 +2693,7 @@ wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2725,7 +2725,7 @@ wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ #' #' @return Returns the tool text outputs. #' @export -wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2762,7 +2762,7 @@ wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_trend_surface_vector_points <- function(input, field, output, cell_size, order=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_trend_surface_vector_points <- function(input, field, output, cell_size, order=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2799,7 +2799,7 @@ wbt_trend_surface_vector_points <- function(input, field, output, cell_size, ord #' #' @return Returns the tool text outputs. #' @export -wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2835,7 +2835,7 @@ wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--base=", wbt_file_path(base))) @@ -2872,7 +2872,7 @@ wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, w #' #' @return Returns the tool text outputs. #' @export -wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2909,7 +2909,7 @@ wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2945,7 +2945,7 @@ wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NU #' #' @return Returns the tool text outputs. #' @export -wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input1=", wbt_file_path(input1))) @@ -2977,7 +2977,7 @@ wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3011,7 +3011,7 @@ wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=FALSE, compress_ra #' #' @return Returns the tool text outputs. #' @export -wbt_zonal_statistics <- function(input, features, output=NULL, stat="mean", out_table=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_zonal_statistics <- function(input, features, output=NULL, stat="mean", out_table=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/precision_agriculture.R b/R/precision_agriculture.R index e2ca11c1f..bc7d03b5e 100644 --- a/R/precision_agriculture.R +++ b/R/precision_agriculture.R @@ -19,7 +19,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, output, radius=NULL, min_yield=NULL, max_yield=NULL, mean_tonnage=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, output, radius=NULL, min_yield=NULL, max_yield=NULL, mean_tonnage=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -68,7 +68,7 @@ wbt_reconcile_multiple_headers <- function(input, region_field, yield_field, out #' #' @return Returns the tool text outputs. #' @export -wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, output_points, max_change_in_heading=25.0, ignore_zeros=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, output_points, max_change_in_heading=25.0, ignore_zeros=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -110,7 +110,7 @@ wbt_recreate_pass_lines <- function(input, yield_field_name, output_lines, outpu #' #' @return Returns the tool text outputs. #' @export -wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in_heading=25.0, flag_edges=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in_heading=25.0, flag_edges=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -156,7 +156,7 @@ wbt_remove_field_edge_points <- function(input, output, dist=NULL, max_change_in #' #' @return Returns the tool text outputs. #' @export -wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096, z_score_threshold=2.5, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096, z_score_threshold=2.5, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -204,7 +204,7 @@ wbt_yield_filter <- function(input, yield_field, pass_field, output, width=6.096 #' #' @return Returns the tool text outputs. #' @export -wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_change_in_heading=25.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_change_in_heading=25.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -247,7 +247,7 @@ wbt_yield_map <- function(input, pass_field_name, output, width=6.096, max_chang #' #' @return Returns the tool text outputs. #' @export -wbt_yield_normalization <- function(input, yield_field, output, standardize=FALSE, radius=NULL, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_yield_normalization <- function(input, yield_field, output, standardize=FALSE, radius=NULL, min_yield=0.0, max_yield=99999.9, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) diff --git a/R/stream_network_analysis.R b/R/stream_network_analysis.R index 58938dbe6..b2823354f 100644 --- a/R/stream_network_analysis.R +++ b/R/stream_network_analysis.R @@ -16,7 +16,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -56,7 +56,7 @@ wbt_distance_to_outlet <- function(d8_pntr, streams, output, esri_pntr=FALSE, ze #' #' @return Returns the tool text outputs. #' @export -wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--flow_accum=", wbt_file_path(flow_accum))) @@ -94,7 +94,7 @@ wbt_extract_streams <- function(flow_accum, output, threshold, zero_background=F #' #' @return Returns the tool text outputs. #' @export -wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filter=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filter=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -137,7 +137,7 @@ wbt_extract_valleys <- function(dem, output, variant="LQ", line_thin=TRUE, filte #' #' @return Returns the tool text outputs. #' @export -wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -178,7 +178,7 @@ wbt_farthest_channel_head <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -219,7 +219,7 @@ wbt_find_main_stem <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_b #' #' @return Returns the tool text outputs. #' @export -wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -260,7 +260,7 @@ wbt_hack_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' #' @return Returns the tool text outputs. #' @export -wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -301,7 +301,7 @@ wbt_horton_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, z #' #' @return Returns the tool text outputs. #' @export -wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -342,7 +342,7 @@ wbt_length_of_upstream_channels <- function(d8_pntr, streams, output, esri_pntr= #' #' @return Returns the tool text outputs. #' @export -wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -381,7 +381,7 @@ wbt_long_profile <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, wd= #' #' @return Returns the tool text outputs. #' @export -wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -419,7 +419,7 @@ wbt_long_profile_from_points <- function(d8_pntr, points, dem, output, esri_pntr #' #' @return Returns the tool text outputs. #' @export -wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--streams=", wbt_file_path(streams))) @@ -457,7 +457,7 @@ wbt_raster_streams_to_vector <- function(streams, d8_pntr, output, esri_pntr=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--streams=", wbt_file_path(streams))) @@ -498,7 +498,7 @@ wbt_rasterize_streams <- function(streams, base, output, nodata=TRUE, feature_id #' #' @return Returns the tool text outputs. #' @export -wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_pntr=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_pntr=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -535,7 +535,7 @@ wbt_remove_short_streams <- function(d8_pntr, streams, output, min_length, esri_ #' #' @return Returns the tool text outputs. #' @export -wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -572,7 +572,7 @@ wbt_repair_stream_vector_topology <- function(input, output, dist="", wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -613,7 +613,7 @@ wbt_shreve_stream_magnitude <- function(d8_pntr, streams, output, esri_pntr=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -654,7 +654,7 @@ wbt_strahler_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -695,7 +695,7 @@ wbt_stream_link_class <- function(d8_pntr, streams, output, esri_pntr=FALSE, zer #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -736,7 +736,7 @@ wbt_stream_link_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -778,7 +778,7 @@ wbt_stream_link_length <- function(d8_pntr, linkid, output, esri_pntr=FALSE, zer #' #' @return Returns the tool text outputs. #' @export -wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -821,7 +821,7 @@ wbt_stream_link_slope <- function(d8_pntr, linkid, dem, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -863,7 +863,7 @@ wbt_stream_slope_continuous <- function(d8_pntr, streams, dem, output, esri_pntr #' #' @return Returns the tool text outputs. #' @export -wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -904,7 +904,7 @@ wbt_topological_stream_order <- function(d8_pntr, streams, output, esri_pntr=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, zero_background=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--d8_pntr=", wbt_file_path(d8_pntr))) @@ -945,7 +945,7 @@ wbt_tributary_identifier <- function(d8_pntr, streams, output, esri_pntr=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_vector_stream_network_analysis <- function(streams, dem, output, cutting_height=10.0, snap=0.1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vector_stream_network_analysis <- function(streams, dem, output, cutting_height=10.0, snap=0.1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--streams=", wbt_file_path(streams))) diff --git a/R/terrain_analysis.R b/R/terrain_analysis.R index c72529dee..8ac76499f 100644 --- a/R/terrain_analysis.R +++ b/R/terrain_analysis.R @@ -15,7 +15,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -53,7 +53,7 @@ wbt_accumulation_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -90,7 +90,7 @@ wbt_aspect <- function(dem, output, zfactor=NULL, wd=NULL, verbose_mode=FALSE, c #' #' @return Returns the tool text outputs. #' @export -wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--routes=", wbt_file_path(routes))) @@ -129,7 +129,7 @@ wbt_assess_route <- function(routes, dem, output, length="", dist=20, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -165,7 +165,7 @@ wbt_average_normal_vector_angular_deviation <- function(dem, output, filter=11, #' #' @return Returns the tool text outputs. #' @export -wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -203,7 +203,7 @@ wbt_breakline_mapping <- function(dem, output, threshold=2.0, min_length=3, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -243,7 +243,7 @@ wbt_circular_variance_of_aspect <- function(dem, output, filter=11, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, interval=10.0, base=0.0, smooth=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max_triangle_edge_length=NULL, interval=10.0, base=0.0, smooth=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -296,7 +296,7 @@ wbt_contours_from_points <- function(input, output, field=NULL, use_z=FALSE, max #' #' @return Returns the tool text outputs. #' @export -wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smooth=9, tolerance=10.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smooth=9, tolerance=10.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -341,7 +341,7 @@ wbt_contours_from_raster <- function(input, output, interval=10.0, base=0.0, smo #' #' @return Returns the tool text outputs. #' @export -wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -382,7 +382,7 @@ wbt_curvedness <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose #' #' @return Returns the tool text outputs. #' @export -wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_treatment="use DEM", weight_value=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_treatment="use DEM", weight_value=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -425,7 +425,7 @@ wbt_dem_void_filling <- function(dem, fill, output, mean_plane_dist=20, edge_tre #' #' @return Returns the tool text outputs. #' @export -wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -464,7 +464,7 @@ wbt_dev_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -503,7 +503,7 @@ wbt_diff_from_mean_elev <- function(dem, output, filterx=11, filtery=11, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -542,7 +542,7 @@ wbt_difference_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -581,7 +581,7 @@ wbt_directional_relief <- function(dem, output, azimuth=0.0, max_dist=NULL, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -621,7 +621,7 @@ wbt_downslope_index <- function(dem, output, drop=2.0, out_type="tangent", wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -661,7 +661,7 @@ wbt_edge_density <- function(dem, output, filter=11, norm_diff=5.0, zfactor=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -695,7 +695,7 @@ wbt_elev_above_pit <- function(dem, output, wd=NULL, verbose_mode=FALSE, compres #' #' @return Returns the tool text outputs. #' @export -wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -735,7 +735,7 @@ wbt_elev_percentile <- function(dem, output, filterx=11, filtery=11, sig_digits= #' #' @return Returns the tool text outputs. #' @export -wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -767,7 +767,7 @@ wbt_elev_relative_to_min_max <- function(dem, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -808,7 +808,7 @@ wbt_elev_relative_to_watershed_min_max <- function(dem, watersheds, output, wd=N #' #' @return Returns the tool text outputs. #' @export -wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_road_width=6.0, typical_width=30.0, max_height=2.0, max_width=60.0, max_increment=0.05, spillout_slope=4.0, remove_embankments=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_road_width=6.0, typical_width=30.0, max_height=2.0, max_width=60.0, max_increment=0.05, spillout_slope=4.0, remove_embankments=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -867,7 +867,7 @@ wbt_embankment_mapping <- function(dem, road_vec, output, search_dist=2.5, min_r #' #' @return Returns the tool text outputs. #' @export -wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", zfactor="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", zfactor="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -912,7 +912,7 @@ wbt_exposure_towards_wind_flux <- function(dem, output, azimuth="", max_dist="", #' #' @return Returns the tool text outputs. #' @export -wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=15.0, num_iter=3, max_diff=0.5, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=15.0, num_iter=3, max_diff=0.5, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -960,7 +960,7 @@ wbt_feature_preserving_smoothing <- function(dem, output, filter=11, norm_diff=1 #' #' @return Returns the tool text outputs. #' @export -wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1000,7 +1000,7 @@ wbt_fetch_analysis <- function(dem, output, azimuth=0.0, hgt_inc=0.05, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1041,7 +1041,7 @@ wbt_fill_missing_data <- function(input, output, filter=11, weight=2.0, no_edges #' #' @return Returns the tool text outputs. #' @export -wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1077,7 +1077,7 @@ wbt_find_ridges <- function(dem, output, line_thin=TRUE, wd=NULL, verbose_mode=F #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1122,7 +1122,7 @@ wbt_gaussian_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, points=NULL, sigma=0.5, step=0.5, num_steps=10, lsp="Slope", z_factor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, points=NULL, sigma=0.5, step=0.5, num_steps=10, lsp="Slope", z_factor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1175,7 +1175,7 @@ wbt_gaussian_scale_space <- function(dem, output, output_zscore, output_scale, p #' #' @return Returns the tool text outputs. #' @export -wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1218,7 +1218,7 @@ wbt_generating_function <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL #' #' @return Returns the tool text outputs. #' @export -wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip=0, forms=TRUE, residuals=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip=0, forms=TRUE, residuals=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1270,7 +1270,7 @@ wbt_geomorphons <- function(dem, output, search=50, threshold=0.0, fdist=0, skip #' #' @return Returns the tool text outputs. #' @export -wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1312,7 +1312,7 @@ wbt_hillshade <- function(dem, output, azimuth=315.0, altitude=30.0, zfactor=NUL #' #' @return Returns the tool text outputs. #' @export -wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1351,7 +1351,7 @@ wbt_horizon_angle <- function(dem, output, azimuth=0.0, max_dist=100.0, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1389,7 +1389,7 @@ wbt_horizontal_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, #' #' @return Returns the tool text outputs. #' @export -wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -1431,7 +1431,7 @@ wbt_hypsometric_analysis <- function(inputs, output, watershed=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_weight=0.5, brightness=0.5, atmospheric=0.0, palette="atlas", reverse=FALSE, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_weight=0.5, brightness=0.5, atmospheric=0.0, palette="atlas", reverse=FALSE, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1491,7 +1491,7 @@ wbt_hypsometrically_tinted_hillshade <- function(dem, output, altitude=45.0, hs_ #' #' @return Returns the tool text outputs. #' @export -wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -1536,7 +1536,7 @@ wbt_local_hypsometric_analysis <- function(input, out_mag, out_scale, min_scale= #' #' @return Returns the tool text outputs. #' @export -wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1572,7 +1572,7 @@ wbt_local_quadratic_regression <- function(dem, output, filter=3, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1613,7 +1613,7 @@ wbt_map_off_terrain_objects <- function(dem, output, max_slope=40.0, min_size=1, #' #' @return Returns the tool text outputs. #' @export -wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale=3, step=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale=3, step=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1656,7 +1656,7 @@ wbt_max_anisotropy_dev <- function(dem, out_mag, out_scale, max_scale, min_scale #' #' @return Returns the tool text outputs. #' @export -wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1696,7 +1696,7 @@ wbt_max_anisotropy_dev_signature <- function(dem, points, output, max_scale, min #' #' @return Returns the tool text outputs. #' @export -wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1734,7 +1734,7 @@ wbt_max_branch_length <- function(dem, output, log=FALSE, wd=NULL, verbose_mode= #' #' @return Returns the tool text outputs. #' @export -wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1771,7 +1771,7 @@ wbt_max_difference_from_mean <- function(dem, out_mag, out_scale, min_scale, max #' #' @return Returns the tool text outputs. #' @export -wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1806,7 +1806,7 @@ wbt_max_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale, step=10, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale, step=10, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1847,7 +1847,7 @@ wbt_max_elev_dev_signature <- function(dem, points, output, min_scale, max_scale #' #' @return Returns the tool text outputs. #' @export -wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_scale, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1884,7 +1884,7 @@ wbt_max_elevation_deviation <- function(dem, out_mag, out_scale, min_scale, max_ #' #' @return Returns the tool text outputs. #' @export -wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1917,7 +1917,7 @@ wbt_max_upslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE #' #' @return Returns the tool text outputs. #' @export -wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1956,7 +1956,7 @@ wbt_maximal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -1993,7 +1993,7 @@ wbt_mean_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2026,7 +2026,7 @@ wbt_min_downslope_elev_change <- function(dem, output, wd=NULL, verbose_mode=FAL #' #' @return Returns the tool text outputs. #' @export -wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2066,7 +2066,7 @@ wbt_minimal_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=NULL, full_mode=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2114,7 +2114,7 @@ wbt_multidirectional_hillshade <- function(dem, output, altitude=45.0, zfactor=N #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out_scale=NULL, min_scale=0, step=1, num_steps=1, step_nonlinearity=1.0, log=TRUE, standardize=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out_scale=NULL, min_scale=0, step=1, num_steps=1, step_nonlinearity=1.0, log=TRUE, standardize=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2175,7 +2175,7 @@ wbt_multiscale_curvatures <- function(dem, out_mag, curv_type="ProfileCurv", out #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_digits=3, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_digits=3, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2226,7 +2226,7 @@ wbt_multiscale_elevation_percentile <- function(dem, out_mag, out_scale, sig_dig #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2269,7 +2269,7 @@ wbt_multiscale_roughness <- function(dem, out_mag, out_scale, max_scale, min_sca #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, min_scale=1, step=1, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2313,7 +2313,7 @@ wbt_multiscale_roughness_signature <- function(dem, points, output, max_scale, m #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2362,7 +2362,7 @@ wbt_multiscale_std_dev_normals <- function(dem, out_mag, out_scale, min_scale=1, #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_scale=1, step=1, num_steps=10, step_nonlinearity=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2410,7 +2410,7 @@ wbt_multiscale_std_dev_normals_signature <- function(dem, points, output, min_sc #' #' @return Returns the tool text outputs. #' @export -wbt_multiscale_topographic_position_image <- function(local, meso, broad, output, hillshade=NULL, lightness=1.2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_multiscale_topographic_position_image <- function(local, meso, broad, output, hillshade=NULL, lightness=1.2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--local=", wbt_file_path(local))) @@ -2449,7 +2449,7 @@ wbt_multiscale_topographic_position_image <- function(local, meso, broad, output #' #' @return Returns the tool text outputs. #' @export -wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2480,7 +2480,7 @@ wbt_num_downslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2513,7 +2513,7 @@ wbt_num_upslope_neighbours <- function(dem, output, wd=NULL, verbose_mode=FALSE, #' #' @return Returns the tool text outputs. #' @export -wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -2552,7 +2552,7 @@ wbt_openness <- function(input, pos_output, neg_output, dist=20, wd=NULL, verbos #' #' @return Returns the tool text outputs. #' @export -wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2597,7 +2597,7 @@ wbt_pennock_landform_class <- function(dem, output, slope=3.0, prof=0.1, plan=0. #' #' @return Returns the tool text outputs. #' @export -wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2636,7 +2636,7 @@ wbt_percent_elev_range <- function(dem, output, filterx=3, filtery=3, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2674,7 +2674,7 @@ wbt_plan_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--lines=", wbt_file_path(lines))) @@ -2708,7 +2708,7 @@ wbt_profile <- function(lines, surface, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2747,7 +2747,7 @@ wbt_profile_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2786,7 +2786,7 @@ wbt_relative_aspect <- function(dem, output, azimuth=0.0, zfactor=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2825,7 +2825,7 @@ wbt_relative_topographic_position <- function(dem, output, filterx=11, filtery=1 #' #' @return Returns the tool text outputs. #' @export -wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2864,7 +2864,7 @@ wbt_remove_off_terrain_objects <- function(dem, output, filter=11, slope=15.0, w #' #' @return Returns the tool text outputs. #' @export -wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2903,7 +2903,7 @@ wbt_ring_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, ver #' #' @return Returns the tool text outputs. #' @export -wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2940,7 +2940,7 @@ wbt_rotor <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode #' #' @return Returns the tool text outputs. #' @export -wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -2974,7 +2974,7 @@ wbt_ruggedness_index <- function(dem, output, wd=NULL, verbose_mode=FALSE, compr #' #' @return Returns the tool text outputs. #' @export -wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, slope_exponent=1.3, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, slope_exponent=1.3, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--sca=", wbt_file_path(sca))) @@ -3020,7 +3020,7 @@ wbt_sediment_transport_index <- function(sca, slope, output, sca_exponent=0.4, s #' #' @return Returns the tool text outputs. #' @export -wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", date="21/06/2021", interval=15, location="43.5448/-80.2482/-4", height=600, delay=250, label="", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", date="21/06/2021", interval=15, location="43.5448/-80.2482/-4", height=600, delay=250, label="", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3080,7 +3080,7 @@ wbt_shadow_animation <- function(input, output, palette="atlas", max_dist="", da #' #' @return Returns the tool text outputs. #' @export -wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="21/06/2021", time="13:00", location="43.5448/-80.2482/-4", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="21/06/2021", time="13:00", location="43.5448/-80.2482/-4", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3127,7 +3127,7 @@ wbt_shadow_image <- function(input, output, palette="soft", max_dist="", date="2 #' #' @return Returns the tool text outputs. #' @export -wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3163,7 +3163,7 @@ wbt_shape_index <- function(dem, output, zfactor=1.0, wd=NULL, verbose_mode=FALS #' #' @return Returns the tool text outputs. #' @export -wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3203,7 +3203,7 @@ wbt_slope <- function(dem, output, zfactor=NULL, units="degrees", wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3244,7 +3244,7 @@ wbt_slope_vs_aspect_plot <- function(input, output, bin_size=2.0, min_slope=0.1, #' #' @return Returns the tool text outputs. #' @export -wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--inputs=", wbt_file_path(inputs))) @@ -3281,7 +3281,7 @@ wbt_slope_vs_elevation_plot <- function(inputs, output, watershed=NULL, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_threshold=1.0, scale_threshold=5, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_threshold=1.0, scale_threshold=5, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3322,7 +3322,7 @@ wbt_smooth_vegetation_residual <- function(input, output, max_scale=30, dev_thre #' #' @return Returns the tool text outputs. #' @export -wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3359,7 +3359,7 @@ wbt_spherical_std_dev_of_normals <- function(dem, output, filter=11, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx=11, filtery=11, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx=11, filtery=11, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3401,7 +3401,7 @@ wbt_standard_deviation_of_slope <- function(input, output, zfactor=NULL, filterx #' #' @return Returns the tool text outputs. #' @export -wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--sca=", wbt_file_path(sca))) @@ -3436,7 +3436,7 @@ wbt_stream_power_index <- function(sca, slope, output, exponent=1.0, wd=NULL, ve #' #' @return Returns the tool text outputs. #' @export -wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3469,7 +3469,7 @@ wbt_surface_area_ratio <- function(dem, output, wd=NULL, verbose_mode=FALSE, com #' #' @return Returns the tool text outputs. #' @export -wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3515,7 +3515,7 @@ wbt_tangential_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NU #' #' @return Returns the tool text outputs. #' @export -wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_dist=100.0, utc_offset="00:00", start_day=1, end_day=365, start_time="00:00:00", end_time="23:59:59", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_dist=100.0, utc_offset="00:00", start_day=1, end_day=365, start_time="00:00:00", end_time="23:59:59", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3579,7 +3579,7 @@ wbt_time_in_daylight <- function(dem, output, lat, long, az_fraction=10.0, max_d #' #' @return Returns the tool text outputs. #' @export -wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=315.0, alt=30.0, background_hgt_offset=10.0, polygon=NULL, background_clr="[255, 255, 255]", attenuation=0.6, ambient_light=0.2, z_factor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=315.0, alt=30.0, background_hgt_offset=10.0, polygon=NULL, background_clr="[255, 255, 255]", attenuation=0.6, ambient_light=0.2, z_factor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3649,7 +3649,7 @@ wbt_topo_render <- function(dem, output, palette="soft", rev_palette=FALSE, az=3 #' #' @return Returns the tool text outputs. #' @export -wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd", min_scale=1, num_steps=100, step_nonlinearity=1.5, height=600, delay=250, label="", dev_max=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd", min_scale=1, num_steps=100, step_nonlinearity=1.5, height=600, delay=250, label="", dev_max=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--input=", wbt_file_path(input))) @@ -3706,7 +3706,7 @@ wbt_topographic_position_animation <- function(input, output, palette="bl_yl_rd" #' #' @return Returns the tool text outputs. #' @export -wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3745,7 +3745,7 @@ wbt_total_curvature <- function(dem, output, log=FALSE, zfactor=NULL, wd=NULL, v #' #' @return Returns the tool text outputs. #' @export -wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3784,7 +3784,7 @@ wbt_unsphericity <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbo #' #' @return Returns the tool text outputs. #' @export -wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3823,7 +3823,7 @@ wbt_vertical_excess_curvature <- function(dem, output, log=FALSE, zfactor=1.0, w #' #' @return Returns the tool text outputs. #' @export -wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3860,7 +3860,7 @@ wbt_viewshed <- function(dem, stations, output, height=2.0, wd=NULL, verbose_mod #' #' @return Returns the tool text outputs. #' @export -wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--dem=", wbt_file_path(dem))) @@ -3898,7 +3898,7 @@ wbt_visibility_index <- function(dem, output, height=2.0, res_factor=2, wd=NULL, #' #' @return Returns the tool text outputs. #' @export -wbt_wetness_index <- function(sca, slope, output, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_wetness_index <- function(sca, slope, output, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" args <- paste(args, paste0("--sca=", wbt_file_path(sca))) diff --git a/R/wbt.R b/R/wbt.R index 29437039b..fd5c8e435 100644 --- a/R/wbt.R +++ b/R/wbt.R @@ -991,7 +991,7 @@ wbt_run_tool <- function(tool_name, args, verbose_mode = FALSE, command_only = F # in "all" mode the full output is shown cat(ret, sep = "\n") ret <- paste(tool_name, "-", ret[length(ret)]) - } else if (!verbose_mode) { + } else if (is.null(verbose_mode) || !verbose_mode) { ret <- paste(tool_name, "-", ret[length(ret)]) } diff --git a/R/whitebox_utilities.R b/R/whitebox_utilities.R index 68885e47d..5dd65f08a 100644 --- a/R/whitebox_utilities.R +++ b/R/whitebox_utilities.R @@ -12,7 +12,7 @@ #' #' @return Returns the tool text outputs. #' @export -wbt_install_wb_extension <- function(install_extension="General Toolset Extension", wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_install_wb_extension <- function(install_extension="General Toolset Extension", wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (!is.null(install_extension)) { @@ -43,7 +43,7 @@ wbt_install_wb_extension <- function(install_extension="General Toolset Extensio #' #' @return Returns the tool text outputs. #' @export -wbt_launch_wb_runner <- function(clear_app_state=FALSE, wd=NULL, verbose_mode=FALSE, compress_rasters=FALSE, command_only=FALSE) { +wbt_launch_wb_runner <- function(clear_app_state=FALSE, wd=NULL, verbose_mode=NULL, compress_rasters=NULL, command_only=FALSE) { wbt_init() args <- "" if (clear_app_state) { From e24cda5a1c49c0ea36e88fe76cf1f6f4821500c5 Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Sun, 1 Oct 2023 08:55:12 -0700 Subject: [PATCH 2/7] 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 #' From 95b9601529b410911e8b648ef74d435366c2ace2 Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Sun, 1 Oct 2023 08:58:34 -0700 Subject: [PATCH 3/7] bump .Rd files --- man/wbt_absolute_value.Rd | 12 ++++++------ man/wbt_accumulation_curvature.Rd | 12 ++++++------ man/wbt_adaptive_filter.Rd | 12 ++++++------ man/wbt_add.Rd | 12 ++++++------ man/wbt_add_point_coordinates_to_table.Rd | 12 ++++++------ man/wbt_aggregate_raster.Rd | 12 ++++++------ man/wbt_and.Rd | 12 ++++++------ man/wbt_anova.Rd | 12 ++++++------ man/wbt_arc_cos.Rd | 12 ++++++------ man/wbt_arc_sin.Rd | 12 ++++++------ man/wbt_arc_tan.Rd | 12 ++++++------ man/wbt_arcosh.Rd | 12 ++++++------ man/wbt_arsinh.Rd | 12 ++++++------ man/wbt_artanh.Rd | 12 ++++++------ man/wbt_ascii_to_las.Rd | 12 ++++++------ man/wbt_aspect.Rd | 12 ++++++------ man/wbt_assess_route.Rd | 12 ++++++------ man/wbt_atan2.Rd | 12 ++++++------ man/wbt_attribute_correlation.Rd | 12 ++++++------ ...t_attribute_correlation_neighbourhood_analysis.Rd | 12 ++++++------ man/wbt_attribute_histogram.Rd | 12 ++++++------ man/wbt_attribute_scattergram.Rd | 12 ++++++------ man/wbt_average_flowpath_slope.Rd | 12 ++++++------ man/wbt_average_normal_vector_angular_deviation.Rd | 12 ++++++------ man/wbt_average_overlay.Rd | 12 ++++++------ man/wbt_average_upslope_flowpath_length.Rd | 12 ++++++------ man/wbt_balance_contrast_enhancement.Rd | 12 ++++++------ man/wbt_basins.Rd | 12 ++++++------ man/wbt_bilateral_filter.Rd | 12 ++++++------ man/wbt_block_maximum_gridding.Rd | 12 ++++++------ man/wbt_block_minimum_gridding.Rd | 12 ++++++------ man/wbt_boundary_shape_complexity.Rd | 12 ++++++------ man/wbt_breach_depressions.Rd | 12 ++++++------ man/wbt_breach_depressions_least_cost.Rd | 12 ++++++------ man/wbt_breach_single_cell_pits.Rd | 12 ++++++------ man/wbt_breakline_mapping.Rd | 12 ++++++------ man/wbt_buffer_raster.Rd | 12 ++++++------ man/wbt_burn_streams_at_roads.Rd | 12 ++++++------ man/wbt_canny_edge_detection.Rd | 12 ++++++------ man/wbt_ceil.Rd | 12 ++++++------ man/wbt_centroid.Rd | 12 ++++++------ man/wbt_centroid_vector.Rd | 12 ++++++------ man/wbt_change_vector_analysis.Rd | 12 ++++++------ man/wbt_circular_variance_of_aspect.Rd | 12 ++++++------ man/wbt_classify_buildings_in_lidar.Rd | 12 ++++++------ man/wbt_classify_lidar.Rd | 12 ++++++------ man/wbt_classify_overlap_points.Rd | 12 ++++++------ man/wbt_clean_vector.Rd | 12 ++++++------ man/wbt_clip.Rd | 12 ++++++------ man/wbt_clip_lidar_to_polygon.Rd | 12 ++++++------ man/wbt_clip_raster_to_polygon.Rd | 12 ++++++------ man/wbt_closing.Rd | 12 ++++++------ man/wbt_clump.Rd | 12 ++++++------ man/wbt_colourize_based_on_class.Rd | 12 ++++++------ man/wbt_colourize_based_on_point_returns.Rd | 12 ++++++------ man/wbt_compactness_ratio.Rd | 12 ++++++------ man/wbt_conditional_evaluation.Rd | 12 ++++++------ man/wbt_conditioned_latin_hypercube.Rd | 12 ++++++------ man/wbt_conservative_smoothing_filter.Rd | 12 ++++++------ man/wbt_construct_vector_tin.Rd | 12 ++++++------ man/wbt_contours_from_points.Rd | 12 ++++++------ man/wbt_contours_from_raster.Rd | 12 ++++++------ man/wbt_convert_nodata_to_zero.Rd | 12 ++++++------ man/wbt_convert_raster_format.Rd | 12 ++++++------ man/wbt_corner_detection.Rd | 12 ++++++------ man/wbt_correct_vignetting.Rd | 12 ++++++------ man/wbt_cos.Rd | 12 ++++++------ man/wbt_cosh.Rd | 12 ++++++------ man/wbt_cost_allocation.Rd | 12 ++++++------ man/wbt_cost_distance.Rd | 12 ++++++------ man/wbt_cost_pathway.Rd | 12 ++++++------ man/wbt_count_if.Rd | 12 ++++++------ man/wbt_create_colour_composite.Rd | 12 ++++++------ man/wbt_create_hexagonal_vector_grid.Rd | 12 ++++++------ man/wbt_create_plane.Rd | 12 ++++++------ man/wbt_create_rectangular_vector_grid.Rd | 12 ++++++------ man/wbt_crispness_index.Rd | 12 ++++++------ man/wbt_cross_tabulation.Rd | 12 ++++++------ man/wbt_csv_points_to_vector.Rd | 12 ++++++------ man/wbt_cumulative_distribution.Rd | 12 ++++++------ man/wbt_curvedness.Rd | 12 ++++++------ man/wbt_d8_flow_accumulation.Rd | 12 ++++++------ man/wbt_d8_mass_flux.Rd | 12 ++++++------ man/wbt_d8_pointer.Rd | 12 ++++++------ man/wbt_d_inf_flow_accumulation.Rd | 12 ++++++------ man/wbt_d_inf_mass_flux.Rd | 12 ++++++------ man/wbt_d_inf_pointer.Rd | 12 ++++++------ man/wbt_dbscan.Rd | 12 ++++++------ man/wbt_decrement.Rd | 12 ++++++------ man/wbt_dem_void_filling.Rd | 12 ++++++------ man/wbt_depth_in_sink.Rd | 12 ++++++------ man/wbt_depth_to_water.Rd | 12 ++++++------ man/wbt_dev_from_mean_elev.Rd | 12 ++++++------ man/wbt_diff_from_mean_elev.Rd | 12 ++++++------ man/wbt_diff_of_gaussian_filter.Rd | 12 ++++++------ man/wbt_difference.Rd | 12 ++++++------ man/wbt_difference_curvature.Rd | 12 ++++++------ man/wbt_direct_decorrelation_stretch.Rd | 12 ++++++------ man/wbt_directional_relief.Rd | 12 ++++++------ man/wbt_dissolve.Rd | 12 ++++++------ man/wbt_distance_to_outlet.Rd | 12 ++++++------ man/wbt_diversity_filter.Rd | 12 ++++++------ man/wbt_divide.Rd | 12 ++++++------ man/wbt_downslope_distance_to_stream.Rd | 12 ++++++------ man/wbt_downslope_flowpath_length.Rd | 12 ++++++------ man/wbt_downslope_index.Rd | 12 ++++++------ man/wbt_edge_contamination.Rd | 12 ++++++------ man/wbt_edge_density.Rd | 12 ++++++------ man/wbt_edge_preserving_mean_filter.Rd | 12 ++++++------ man/wbt_edge_proportion.Rd | 12 ++++++------ man/wbt_elev_above_pit.Rd | 12 ++++++------ man/wbt_elev_percentile.Rd | 12 ++++++------ man/wbt_elev_relative_to_min_max.Rd | 12 ++++++------ man/wbt_elev_relative_to_watershed_min_max.Rd | 12 ++++++------ man/wbt_elevation_above_stream.Rd | 12 ++++++------ man/wbt_elevation_above_stream_euclidean.Rd | 12 ++++++------ man/wbt_eliminate_coincident_points.Rd | 12 ++++++------ man/wbt_elongation_ratio.Rd | 12 ++++++------ man/wbt_embankment_mapping.Rd | 12 ++++++------ man/wbt_emboss_filter.Rd | 12 ++++++------ man/wbt_equal_to.Rd | 12 ++++++------ man/wbt_erase.Rd | 12 ++++++------ man/wbt_erase_polygon_from_lidar.Rd | 12 ++++++------ man/wbt_erase_polygon_from_raster.Rd | 12 ++++++------ man/wbt_euclidean_allocation.Rd | 12 ++++++------ man/wbt_euclidean_distance.Rd | 12 ++++++------ man/wbt_evaluate_training_sites.Rd | 12 ++++++------ man/wbt_exp.Rd | 12 ++++++------ man/wbt_exp2.Rd | 12 ++++++------ man/wbt_export_table_to_csv.Rd | 12 ++++++------ man/wbt_exposure_towards_wind_flux.Rd | 12 ++++++------ man/wbt_extend_vector_lines.Rd | 12 ++++++------ man/wbt_extract_nodes.Rd | 12 ++++++------ man/wbt_extract_raster_values_at_points.Rd | 12 ++++++------ man/wbt_extract_streams.Rd | 12 ++++++------ man/wbt_extract_valleys.Rd | 12 ++++++------ man/wbt_farthest_channel_head.Rd | 12 ++++++------ man/wbt_fast_almost_gaussian_filter.Rd | 12 ++++++------ man/wbt_fd8_flow_accumulation.Rd | 12 ++++++------ man/wbt_fd8_pointer.Rd | 12 ++++++------ man/wbt_feature_preserving_smoothing.Rd | 12 ++++++------ man/wbt_fetch_analysis.Rd | 12 ++++++------ man/wbt_fill_burn.Rd | 12 ++++++------ man/wbt_fill_depressions.Rd | 12 ++++++------ man/wbt_fill_depressions_planchon_and_darboux.Rd | 12 ++++++------ man/wbt_fill_depressions_wang_and_liu.Rd | 12 ++++++------ man/wbt_fill_missing_data.Rd | 12 ++++++------ man/wbt_fill_single_cell_pits.Rd | 12 ++++++------ man/wbt_filter_lidar.Rd | 12 ++++++------ man/wbt_filter_lidar_classes.Rd | 12 ++++++------ man/wbt_filter_lidar_scan_angles.Rd | 12 ++++++------ man/wbt_filter_raster_features_by_area.Rd | 12 ++++++------ man/wbt_find_flightline_edge_points.Rd | 12 ++++++------ man/wbt_find_lowest_or_highest_points.Rd | 12 ++++++------ man/wbt_find_main_stem.Rd | 12 ++++++------ man/wbt_find_no_flow_cells.Rd | 12 ++++++------ man/wbt_find_parallel_flow.Rd | 12 ++++++------ man/wbt_find_patch_or_class_edge_cells.Rd | 12 ++++++------ man/wbt_find_ridges.Rd | 12 ++++++------ man/wbt_fix_dangling_arcs.Rd | 12 ++++++------ man/wbt_flatten_lakes.Rd | 12 ++++++------ man/wbt_flightline_overlap.Rd | 12 ++++++------ man/wbt_flip_image.Rd | 12 ++++++------ man/wbt_flood_order.Rd | 12 ++++++------ man/wbt_floor.Rd | 12 ++++++------ man/wbt_flow_accumulation_full_workflow.Rd | 12 ++++++------ man/wbt_flow_length_diff.Rd | 12 ++++++------ man/wbt_gamma_correction.Rd | 12 ++++++------ man/wbt_gaussian_contrast_stretch.Rd | 12 ++++++------ man/wbt_gaussian_curvature.Rd | 12 ++++++------ man/wbt_gaussian_filter.Rd | 12 ++++++------ man/wbt_gaussian_scale_space.Rd | 12 ++++++------ man/wbt_generalize_classified_raster.Rd | 12 ++++++------ man/wbt_generalize_with_similarity.Rd | 12 ++++++------ man/wbt_generating_function.Rd | 12 ++++++------ man/wbt_geomorphons.Rd | 12 ++++++------ man/wbt_greater_than.Rd | 12 ++++++------ man/wbt_hack_stream_order.Rd | 12 ++++++------ man/wbt_heat_map.Rd | 12 ++++++------ man/wbt_height_above_ground.Rd | 12 ++++++------ man/wbt_high_pass_bilateral_filter.Rd | 12 ++++++------ man/wbt_high_pass_filter.Rd | 12 ++++++------ man/wbt_high_pass_median_filter.Rd | 12 ++++++------ man/wbt_highest_position.Rd | 12 ++++++------ man/wbt_hillshade.Rd | 12 ++++++------ man/wbt_hillslopes.Rd | 12 ++++++------ man/wbt_histogram_equalization.Rd | 12 ++++++------ man/wbt_histogram_matching.Rd | 12 ++++++------ man/wbt_histogram_matching_two_images.Rd | 12 ++++++------ man/wbt_hole_proportion.Rd | 12 ++++++------ man/wbt_horizon_angle.Rd | 12 ++++++------ man/wbt_horizontal_excess_curvature.Rd | 12 ++++++------ man/wbt_horton_stream_order.Rd | 12 ++++++------ man/wbt_hydrologic_connectivity.Rd | 12 ++++++------ man/wbt_hypsometric_analysis.Rd | 12 ++++++------ man/wbt_hypsometrically_tinted_hillshade.Rd | 12 ++++++------ man/wbt_idw_interpolation.Rd | 12 ++++++------ man/wbt_ihs_to_rgb.Rd | 12 ++++++------ man/wbt_image_autocorrelation.Rd | 12 ++++++------ man/wbt_image_correlation.Rd | 12 ++++++------ man/wbt_image_correlation_neighbourhood_analysis.Rd | 12 ++++++------ man/wbt_image_regression.Rd | 12 ++++++------ man/wbt_image_segmentation.Rd | 12 ++++++------ man/wbt_image_slider.Rd | 12 ++++++------ man/wbt_image_stack_profile.Rd | 12 ++++++------ man/wbt_impoundment_size_index.Rd | 12 ++++++------ man/wbt_in_place_add.Rd | 12 ++++++------ man/wbt_in_place_divide.Rd | 12 ++++++------ man/wbt_in_place_multiply.Rd | 12 ++++++------ man/wbt_in_place_subtract.Rd | 12 ++++++------ man/wbt_increment.Rd | 12 ++++++------ man/wbt_individual_tree_detection.Rd | 12 ++++++------ man/wbt_insert_dams.Rd | 12 ++++++------ man/wbt_install_wb_extension.Rd | 12 ++++++------ man/wbt_integer_division.Rd | 12 ++++++------ man/wbt_integral_image.Rd | 12 ++++++------ man/wbt_intersect.Rd | 12 ++++++------ man/wbt_inverse_principal_component_analysis.Rd | 12 ++++++------ man/wbt_is_no_data.Rd | 12 ++++++------ man/wbt_isobasins.Rd | 12 ++++++------ man/wbt_jenson_snap_pour_points.Rd | 12 ++++++------ man/wbt_join_tables.Rd | 12 ++++++------ man/wbt_k_means_clustering.Rd | 12 ++++++------ man/wbt_k_nearest_mean_filter.Rd | 12 ++++++------ man/wbt_kappa_index.Rd | 12 ++++++------ man/wbt_knn_classification.Rd | 12 ++++++------ man/wbt_knn_regression.Rd | 12 ++++++------ man/wbt_ks_test_for_normality.Rd | 12 ++++++------ man/wbt_laplacian_filter.Rd | 12 ++++++------ man/wbt_laplacian_of_gaussian_filter.Rd | 12 ++++++------ man/wbt_las_to_ascii.Rd | 12 ++++++------ man/wbt_las_to_laz.Rd | 12 ++++++------ man/wbt_las_to_multipoint_shapefile.Rd | 12 ++++++------ man/wbt_las_to_shapefile.Rd | 12 ++++++------ man/wbt_las_to_zlidar.Rd | 12 ++++++------ man/wbt_launch_wb_runner.Rd | 12 ++++++------ man/wbt_layer_footprint.Rd | 12 ++++++------ man/wbt_laz_to_las.Rd | 12 ++++++------ man/wbt_lee_sigma_filter.Rd | 12 ++++++------ man/wbt_length_of_upstream_channels.Rd | 12 ++++++------ man/wbt_less_than.Rd | 12 ++++++------ man/wbt_lidar_block_maximum.Rd | 12 ++++++------ man/wbt_lidar_block_minimum.Rd | 12 ++++++------ man/wbt_lidar_classify_subset.Rd | 12 ++++++------ man/wbt_lidar_colourize.Rd | 12 ++++++------ man/wbt_lidar_contour.Rd | 12 ++++++------ man/wbt_lidar_digital_surface_model.Rd | 12 ++++++------ man/wbt_lidar_eigenvalue_features.Rd | 12 ++++++------ man/wbt_lidar_elevation_slice.Rd | 12 ++++++------ man/wbt_lidar_ground_point_filter.Rd | 12 ++++++------ man/wbt_lidar_hex_binning.Rd | 12 ++++++------ man/wbt_lidar_hillshade.Rd | 12 ++++++------ man/wbt_lidar_histogram.Rd | 12 ++++++------ man/wbt_lidar_idw_interpolation.Rd | 12 ++++++------ man/wbt_lidar_info.Rd | 12 ++++++------ man/wbt_lidar_join.Rd | 12 ++++++------ man/wbt_lidar_kappa_index.Rd | 12 ++++++------ man/wbt_lidar_nearest_neighbour_gridding.Rd | 12 ++++++------ man/wbt_lidar_point_density.Rd | 12 ++++++------ man/wbt_lidar_point_return_analysis.Rd | 12 ++++++------ man/wbt_lidar_point_stats.Rd | 12 ++++++------ man/wbt_lidar_ransac_planes.Rd | 12 ++++++------ man/wbt_lidar_rbf_interpolation.Rd | 12 ++++++------ man/wbt_lidar_remove_duplicates.Rd | 12 ++++++------ man/wbt_lidar_remove_outliers.Rd | 12 ++++++------ man/wbt_lidar_rooftop_analysis.Rd | 12 ++++++------ man/wbt_lidar_segmentation.Rd | 12 ++++++------ man/wbt_lidar_segmentation_based_filter.Rd | 12 ++++++------ man/wbt_lidar_shift.Rd | 12 ++++++------ man/wbt_lidar_sibson_interpolation.Rd | 12 ++++++------ man/wbt_lidar_sort_by_time.Rd | 12 ++++++------ man/wbt_lidar_thin.Rd | 12 ++++++------ man/wbt_lidar_thin_high_density.Rd | 12 ++++++------ man/wbt_lidar_tile.Rd | 12 ++++++------ man/wbt_lidar_tile_footprint.Rd | 12 ++++++------ man/wbt_lidar_tin_gridding.Rd | 12 ++++++------ man/wbt_lidar_tophat_transform.Rd | 12 ++++++------ man/wbt_line_detection_filter.Rd | 12 ++++++------ man/wbt_line_intersections.Rd | 12 ++++++------ man/wbt_line_thinning.Rd | 12 ++++++------ man/wbt_linearity_index.Rd | 12 ++++++------ man/wbt_lines_to_polygons.Rd | 12 ++++++------ man/wbt_list_unique_values.Rd | 12 ++++++------ man/wbt_list_unique_values_raster.Rd | 12 ++++++------ man/wbt_ln.Rd | 12 ++++++------ man/wbt_local_hypsometric_analysis.Rd | 12 ++++++------ man/wbt_local_quadratic_regression.Rd | 12 ++++++------ man/wbt_log10.Rd | 12 ++++++------ man/wbt_log2.Rd | 12 ++++++------ man/wbt_logistic_regression.Rd | 12 ++++++------ man/wbt_long_profile.Rd | 12 ++++++------ man/wbt_long_profile_from_points.Rd | 12 ++++++------ man/wbt_longest_flowpath.Rd | 12 ++++++------ man/wbt_low_points_on_headwater_divides.Rd | 12 ++++++------ man/wbt_lowest_position.Rd | 12 ++++++------ man/wbt_majority_filter.Rd | 12 ++++++------ man/wbt_map_off_terrain_objects.Rd | 12 ++++++------ man/wbt_max.Rd | 12 ++++++------ man/wbt_max_absolute_overlay.Rd | 12 ++++++------ man/wbt_max_anisotropy_dev.Rd | 12 ++++++------ man/wbt_max_anisotropy_dev_signature.Rd | 12 ++++++------ man/wbt_max_branch_length.Rd | 12 ++++++------ man/wbt_max_difference_from_mean.Rd | 12 ++++++------ man/wbt_max_downslope_elev_change.Rd | 12 ++++++------ man/wbt_max_elev_dev_signature.Rd | 12 ++++++------ man/wbt_max_elevation_deviation.Rd | 12 ++++++------ man/wbt_max_overlay.Rd | 12 ++++++------ man/wbt_max_upslope_elev_change.Rd | 12 ++++++------ man/wbt_max_upslope_flowpath_length.Rd | 12 ++++++------ man/wbt_max_upslope_value.Rd | 12 ++++++------ man/wbt_maximal_curvature.Rd | 12 ++++++------ man/wbt_maximum_filter.Rd | 12 ++++++------ man/wbt_md_inf_flow_accumulation.Rd | 12 ++++++------ man/wbt_mean_curvature.Rd | 12 ++++++------ man/wbt_mean_filter.Rd | 12 ++++++------ man/wbt_median_filter.Rd | 12 ++++++------ man/wbt_medoid.Rd | 12 ++++++------ man/wbt_merge_line_segments.Rd | 12 ++++++------ man/wbt_merge_table_with_csv.Rd | 12 ++++++------ man/wbt_merge_vectors.Rd | 12 ++++++------ man/wbt_min.Rd | 12 ++++++------ man/wbt_min_absolute_overlay.Rd | 12 ++++++------ man/wbt_min_dist_classification.Rd | 12 ++++++------ man/wbt_min_downslope_elev_change.Rd | 12 ++++++------ man/wbt_min_max_contrast_stretch.Rd | 12 ++++++------ man/wbt_min_overlay.Rd | 12 ++++++------ man/wbt_minimal_curvature.Rd | 12 ++++++------ man/wbt_minimum_bounding_box.Rd | 12 ++++++------ man/wbt_minimum_bounding_circle.Rd | 12 ++++++------ man/wbt_minimum_bounding_envelope.Rd | 12 ++++++------ man/wbt_minimum_convex_hull.Rd | 12 ++++++------ man/wbt_minimum_filter.Rd | 12 ++++++------ man/wbt_modified_k_means_clustering.Rd | 12 ++++++------ man/wbt_modify_lidar.Rd | 12 ++++++------ man/wbt_modify_no_data_value.Rd | 12 ++++++------ man/wbt_modulo.Rd | 12 ++++++------ man/wbt_mosaic.Rd | 12 ++++++------ man/wbt_mosaic_with_feathering.Rd | 12 ++++++------ man/wbt_multi_part_to_single_part.Rd | 12 ++++++------ man/wbt_multidirectional_hillshade.Rd | 12 ++++++------ man/wbt_multiply.Rd | 12 ++++++------ man/wbt_multiply_overlay.Rd | 12 ++++++------ man/wbt_multiscale_curvatures.Rd | 12 ++++++------ man/wbt_multiscale_elevation_percentile.Rd | 12 ++++++------ man/wbt_multiscale_roughness.Rd | 12 ++++++------ man/wbt_multiscale_roughness_signature.Rd | 12 ++++++------ man/wbt_multiscale_std_dev_normals.Rd | 12 ++++++------ man/wbt_multiscale_std_dev_normals_signature.Rd | 12 ++++++------ man/wbt_multiscale_topographic_position_image.Rd | 12 ++++++------ man/wbt_narrowness_index.Rd | 12 ++++++------ man/wbt_natural_neighbour_interpolation.Rd | 12 ++++++------ man/wbt_nearest_neighbour_gridding.Rd | 12 ++++++------ man/wbt_negate.Rd | 12 ++++++------ man/wbt_new_raster_from_base.Rd | 12 ++++++------ man/wbt_normal_vectors.Rd | 12 ++++++------ man/wbt_normalize_lidar.Rd | 12 ++++++------ man/wbt_normalized_difference_index.Rd | 12 ++++++------ man/wbt_not.Rd | 12 ++++++------ man/wbt_not_equal_to.Rd | 12 ++++++------ man/wbt_num_downslope_neighbours.Rd | 12 ++++++------ man/wbt_num_inflowing_neighbours.Rd | 12 ++++++------ man/wbt_num_upslope_neighbours.Rd | 12 ++++++------ man/wbt_olympic_filter.Rd | 12 ++++++------ man/wbt_opening.Rd | 12 ++++++------ man/wbt_openness.Rd | 12 ++++++------ man/wbt_or.Rd | 12 ++++++------ man/wbt_paired_sample_t_test.Rd | 12 ++++++------ man/wbt_panchromatic_sharpening.Rd | 12 ++++++------ man/wbt_parallelepiped_classification.Rd | 12 ++++++------ man/wbt_patch_orientation.Rd | 12 ++++++------ man/wbt_pennock_landform_class.Rd | 12 ++++++------ man/wbt_percent_elev_range.Rd | 12 ++++++------ man/wbt_percent_equal_to.Rd | 12 ++++++------ man/wbt_percent_greater_than.Rd | 12 ++++++------ man/wbt_percent_less_than.Rd | 12 ++++++------ man/wbt_percentage_contrast_stretch.Rd | 12 ++++++------ man/wbt_percentile_filter.Rd | 12 ++++++------ man/wbt_perimeter_area_ratio.Rd | 12 ++++++------ man/wbt_phi_coefficient.Rd | 12 ++++++------ man/wbt_pick_from_list.Rd | 12 ++++++------ man/wbt_piecewise_contrast_stretch.Rd | 12 ++++++------ man/wbt_plan_curvature.Rd | 12 ++++++------ man/wbt_polygon_area.Rd | 12 ++++++------ man/wbt_polygon_long_axis.Rd | 12 ++++++------ man/wbt_polygon_perimeter.Rd | 12 ++++++------ man/wbt_polygon_short_axis.Rd | 12 ++++++------ man/wbt_polygonize.Rd | 12 ++++++------ man/wbt_polygons_to_lines.Rd | 12 ++++++------ man/wbt_power.Rd | 12 ++++++------ man/wbt_prewitt_filter.Rd | 12 ++++++------ man/wbt_principal_component_analysis.Rd | 12 ++++++------ man/wbt_print_geo_tiff_tags.Rd | 12 ++++++------ man/wbt_profile.Rd | 12 ++++++------ man/wbt_profile_curvature.Rd | 12 ++++++------ man/wbt_qin_flow_accumulation.Rd | 12 ++++++------ man/wbt_quantiles.Rd | 12 ++++++------ man/wbt_quinn_flow_accumulation.Rd | 12 ++++++------ man/wbt_radial_basis_function_interpolation.Rd | 12 ++++++------ man/wbt_radius_of_gyration.Rd | 12 ++++++------ man/wbt_raise_walls.Rd | 12 ++++++------ man/wbt_random_field.Rd | 12 ++++++------ man/wbt_random_forest_classification.Rd | 12 ++++++------ man/wbt_random_forest_regression.Rd | 12 ++++++------ man/wbt_random_sample.Rd | 12 ++++++------ man/wbt_range_filter.Rd | 12 ++++++------ man/wbt_raster_area.Rd | 12 ++++++------ man/wbt_raster_calculator.Rd | 12 ++++++------ man/wbt_raster_cell_assignment.Rd | 12 ++++++------ man/wbt_raster_histogram.Rd | 12 ++++++------ man/wbt_raster_perimeter.Rd | 12 ++++++------ man/wbt_raster_streams_to_vector.Rd | 12 ++++++------ man/wbt_raster_summary_stats.Rd | 12 ++++++------ man/wbt_raster_to_vector_lines.Rd | 12 ++++++------ man/wbt_raster_to_vector_points.Rd | 12 ++++++------ man/wbt_raster_to_vector_polygons.Rd | 12 ++++++------ man/wbt_rasterize_streams.Rd | 12 ++++++------ man/wbt_reciprocal.Rd | 12 ++++++------ man/wbt_reclass.Rd | 12 ++++++------ man/wbt_reclass_equal_interval.Rd | 12 ++++++------ man/wbt_reclass_from_file.Rd | 12 ++++++------ man/wbt_reconcile_multiple_headers.Rd | 12 ++++++------ man/wbt_recover_flightline_info.Rd | 12 ++++++------ man/wbt_recreate_pass_lines.Rd | 12 ++++++------ man/wbt_reinitialize_attribute_table.Rd | 12 ++++++------ man/wbt_related_circumscribing_circle.Rd | 12 ++++++------ man/wbt_relative_aspect.Rd | 12 ++++++------ man/wbt_relative_topographic_position.Rd | 12 ++++++------ man/wbt_remove_field_edge_points.Rd | 12 ++++++------ man/wbt_remove_off_terrain_objects.Rd | 12 ++++++------ man/wbt_remove_polygon_holes.Rd | 12 ++++++------ man/wbt_remove_raster_polygon_holes.Rd | 12 ++++++------ man/wbt_remove_short_streams.Rd | 12 ++++++------ man/wbt_remove_spurs.Rd | 12 ++++++------ man/wbt_repair_stream_vector_topology.Rd | 12 ++++++------ man/wbt_resample.Rd | 12 ++++++------ man/wbt_rescale_value_range.Rd | 12 ++++++------ man/wbt_rgb_to_ihs.Rd | 12 ++++++------ man/wbt_rho8_flow_accumulation.Rd | 12 ++++++------ man/wbt_rho8_pointer.Rd | 12 ++++++------ man/wbt_ring_curvature.Rd | 12 ++++++------ man/wbt_river_centerlines.Rd | 12 ++++++------ man/wbt_roberts_cross_filter.Rd | 12 ++++++------ man/wbt_root_mean_square_error.Rd | 12 ++++++------ man/wbt_rotor.Rd | 12 ++++++------ man/wbt_round.Rd | 12 ++++++------ man/wbt_ruggedness_index.Rd | 12 ++++++------ man/wbt_scharr_filter.Rd | 12 ++++++------ man/wbt_sediment_transport_index.Rd | 12 ++++++------ man/wbt_select_tiles_by_polygon.Rd | 12 ++++++------ man/wbt_set_nodata_value.Rd | 12 ++++++------ man/wbt_shadow_animation.Rd | 12 ++++++------ man/wbt_shadow_image.Rd | 12 ++++++------ man/wbt_shape_complexity_index.Rd | 12 ++++++------ man/wbt_shape_complexity_index_raster.Rd | 12 ++++++------ man/wbt_shape_index.Rd | 12 ++++++------ man/wbt_shreve_stream_magnitude.Rd | 12 ++++++------ man/wbt_sigmoidal_contrast_stretch.Rd | 12 ++++++------ man/wbt_sin.Rd | 12 ++++++------ man/wbt_single_part_to_multi_part.Rd | 12 ++++++------ man/wbt_sinh.Rd | 12 ++++++------ man/wbt_sink.Rd | 12 ++++++------ man/wbt_slope.Rd | 12 ++++++------ man/wbt_slope_vs_aspect_plot.Rd | 12 ++++++------ man/wbt_slope_vs_elevation_plot.Rd | 12 ++++++------ man/wbt_smooth_vectors.Rd | 12 ++++++------ man/wbt_smooth_vegetation_residual.Rd | 12 ++++++------ man/wbt_snap_pour_points.Rd | 12 ++++++------ man/wbt_sobel_filter.Rd | 12 ++++++------ man/wbt_sort_lidar.Rd | 12 ++++++------ man/wbt_spherical_std_dev_of_normals.Rd | 12 ++++++------ man/wbt_split_colour_composite.Rd | 12 ++++++------ man/wbt_split_lidar.Rd | 12 ++++++------ man/wbt_split_vector_lines.Rd | 12 ++++++------ man/wbt_split_with_lines.Rd | 12 ++++++------ man/wbt_square.Rd | 12 ++++++------ man/wbt_square_root.Rd | 12 ++++++------ man/wbt_standard_deviation_contrast_stretch.Rd | 12 ++++++------ man/wbt_standard_deviation_filter.Rd | 12 ++++++------ man/wbt_standard_deviation_of_slope.Rd | 12 ++++++------ man/wbt_stochastic_depression_analysis.Rd | 12 ++++++------ man/wbt_strahler_order_basins.Rd | 12 ++++++------ man/wbt_strahler_stream_order.Rd | 12 ++++++------ man/wbt_stream_link_class.Rd | 12 ++++++------ man/wbt_stream_link_identifier.Rd | 12 ++++++------ man/wbt_stream_link_length.Rd | 12 ++++++------ man/wbt_stream_link_slope.Rd | 12 ++++++------ man/wbt_stream_power_index.Rd | 12 ++++++------ man/wbt_stream_slope_continuous.Rd | 12 ++++++------ man/wbt_subbasins.Rd | 12 ++++++------ man/wbt_subtract.Rd | 12 ++++++------ man/wbt_sum_overlay.Rd | 12 ++++++------ man/wbt_surface_area_ratio.Rd | 12 ++++++------ man/wbt_svm_classification.Rd | 12 ++++++------ man/wbt_svm_regression.Rd | 12 ++++++------ man/wbt_symmetrical_difference.Rd | 12 ++++++------ man/wbt_tan.Rd | 12 ++++++------ man/wbt_tangential_curvature.Rd | 12 ++++++------ man/wbt_tanh.Rd | 12 ++++++------ man/wbt_thicken_raster_line.Rd | 12 ++++++------ man/wbt_time_in_daylight.Rd | 12 ++++++------ man/wbt_tin_gridding.Rd | 12 ++++++------ man/wbt_to_degrees.Rd | 12 ++++++------ man/wbt_to_radians.Rd | 12 ++++++------ man/wbt_tophat_transform.Rd | 12 ++++++------ man/wbt_topo_render.Rd | 12 ++++++------ man/wbt_topographic_position_animation.Rd | 12 ++++++------ man/wbt_topological_stream_order.Rd | 12 ++++++------ man/wbt_total_curvature.Rd | 12 ++++++------ man/wbt_total_filter.Rd | 12 ++++++------ man/wbt_trace_downslope_flowpaths.Rd | 12 ++++++------ man/wbt_travelling_salesman_problem.Rd | 12 ++++++------ man/wbt_trend_surface.Rd | 12 ++++++------ man/wbt_trend_surface_vector_points.Rd | 12 ++++++------ man/wbt_tributary_identifier.Rd | 12 ++++++------ man/wbt_truncate.Rd | 12 ++++++------ man/wbt_turning_bands_simulation.Rd | 12 ++++++------ man/wbt_two_sample_ks_test.Rd | 12 ++++++------ man/wbt_union.Rd | 12 ++++++------ man/wbt_unnest_basins.Rd | 12 ++++++------ man/wbt_unsharp_masking.Rd | 12 ++++++------ man/wbt_unsphericity.Rd | 12 ++++++------ man/wbt_update_nodata_cells.Rd | 12 ++++++------ man/wbt_upslope_depression_storage.Rd | 12 ++++++------ man/wbt_user_defined_weights_filter.Rd | 12 ++++++------ man/wbt_vector_hex_binning.Rd | 12 ++++++------ man/wbt_vector_lines_to_raster.Rd | 12 ++++++------ man/wbt_vector_points_to_raster.Rd | 12 ++++++------ man/wbt_vector_polygons_to_raster.Rd | 12 ++++++------ man/wbt_vector_stream_network_analysis.Rd | 12 ++++++------ man/wbt_vertical_excess_curvature.Rd | 12 ++++++------ man/wbt_viewshed.Rd | 12 ++++++------ man/wbt_visibility_index.Rd | 12 ++++++------ man/wbt_voronoi_diagram.Rd | 12 ++++++------ man/wbt_watershed.Rd | 12 ++++++------ man/wbt_weighted_overlay.Rd | 12 ++++++------ man/wbt_weighted_sum.Rd | 12 ++++++------ man/wbt_wetness_index.Rd | 12 ++++++------ man/wbt_wilcoxon_signed_rank_test.Rd | 12 ++++++------ man/wbt_write_function_memory_insertion.Rd | 12 ++++++------ man/wbt_xor.Rd | 12 ++++++------ man/wbt_yield_filter.Rd | 12 ++++++------ man/wbt_yield_map.Rd | 12 ++++++------ man/wbt_yield_normalization.Rd | 12 ++++++------ man/wbt_z_scores.Rd | 12 ++++++------ man/wbt_zlidar_to_las.Rd | 12 ++++++------ man/wbt_zonal_statistics.Rd | 12 ++++++------ 546 files changed, 3276 insertions(+), 3276 deletions(-) diff --git a/man/wbt_absolute_value.Rd b/man/wbt_absolute_value.Rd index 4e5cd8418..83893d60e 100644 --- a/man/wbt_absolute_value.Rd +++ b/man/wbt_absolute_value.Rd @@ -8,8 +8,8 @@ wbt_absolute_value( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_absolute_value( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_accumulation_curvature.Rd b/man/wbt_accumulation_curvature.Rd index 408cb55d0..258e82f5f 100644 --- a/man/wbt_accumulation_curvature.Rd +++ b/man/wbt_accumulation_curvature.Rd @@ -10,8 +10,8 @@ wbt_accumulation_curvature( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_accumulation_curvature( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_adaptive_filter.Rd b/man/wbt_adaptive_filter.Rd index 2b15116d4..f799264d4 100644 --- a/man/wbt_adaptive_filter.Rd +++ b/man/wbt_adaptive_filter.Rd @@ -11,8 +11,8 @@ wbt_adaptive_filter( filtery = 11, threshold = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_adaptive_filter( \item{threshold}{Difference from mean threshold, in standard deviations.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_add.Rd b/man/wbt_add.Rd index c77e29ed0..65661842d 100644 --- a/man/wbt_add.Rd +++ b/man/wbt_add.Rd @@ -9,8 +9,8 @@ wbt_add( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_add( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_add_point_coordinates_to_table.Rd b/man/wbt_add_point_coordinates_to_table.Rd index a7c8501ba..80c745ccd 100644 --- a/man/wbt_add_point_coordinates_to_table.Rd +++ b/man/wbt_add_point_coordinates_to_table.Rd @@ -7,21 +7,21 @@ wbt_add_point_coordinates_to_table( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector Points file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_aggregate_raster.Rd b/man/wbt_aggregate_raster.Rd index 4e8181acd..9af61f229 100644 --- a/man/wbt_aggregate_raster.Rd +++ b/man/wbt_aggregate_raster.Rd @@ -10,8 +10,8 @@ wbt_aggregate_raster( agg_factor = 2, type = "mean", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_aggregate_raster( \item{type}{Statistic used to fill output pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_and.Rd b/man/wbt_and.Rd index d04149b70..d968316cf 100644 --- a/man/wbt_and.Rd +++ b/man/wbt_and.Rd @@ -9,8 +9,8 @@ wbt_and( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_and( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_anova.Rd b/man/wbt_anova.Rd index 36c0f28a3..8afb894c1 100644 --- a/man/wbt_anova.Rd +++ b/man/wbt_anova.Rd @@ -9,8 +9,8 @@ wbt_anova( features, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_anova( \item{output}{Output HTML file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_arc_cos.Rd b/man/wbt_arc_cos.Rd index 3a49b8614..ce6fd7a44 100644 --- a/man/wbt_arc_cos.Rd +++ b/man/wbt_arc_cos.Rd @@ -8,8 +8,8 @@ wbt_arc_cos( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_arc_cos( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_arc_sin.Rd b/man/wbt_arc_sin.Rd index d0f4d0cdf..5e328eca4 100644 --- a/man/wbt_arc_sin.Rd +++ b/man/wbt_arc_sin.Rd @@ -8,8 +8,8 @@ wbt_arc_sin( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_arc_sin( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_arc_tan.Rd b/man/wbt_arc_tan.Rd index 8eb285f08..6b4b06a6b 100644 --- a/man/wbt_arc_tan.Rd +++ b/man/wbt_arc_tan.Rd @@ -8,8 +8,8 @@ wbt_arc_tan( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_arc_tan( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_arcosh.Rd b/man/wbt_arcosh.Rd index e7631cb6c..58984c5a0 100644 --- a/man/wbt_arcosh.Rd +++ b/man/wbt_arcosh.Rd @@ -8,8 +8,8 @@ wbt_arcosh( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_arcosh( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_arsinh.Rd b/man/wbt_arsinh.Rd index ee5cedd1e..f2fe43a2b 100644 --- a/man/wbt_arsinh.Rd +++ b/man/wbt_arsinh.Rd @@ -8,8 +8,8 @@ wbt_arsinh( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_arsinh( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_artanh.Rd b/man/wbt_artanh.Rd index 4e87ed20f..ebf557c24 100644 --- a/man/wbt_artanh.Rd +++ b/man/wbt_artanh.Rd @@ -8,8 +8,8 @@ wbt_artanh( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_artanh( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_ascii_to_las.Rd b/man/wbt_ascii_to_las.Rd index 05bd5e950..1430c9d47 100644 --- a/man/wbt_ascii_to_las.Rd +++ b/man/wbt_ascii_to_las.Rd @@ -9,8 +9,8 @@ wbt_ascii_to_las( pattern, proj = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_ascii_to_las( \item{proj}{Well-known-text string or EPSG code describing projection.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_aspect.Rd b/man/wbt_aspect.Rd index 7b3c9be2d..66203e71e 100644 --- a/man/wbt_aspect.Rd +++ b/man/wbt_aspect.Rd @@ -9,8 +9,8 @@ wbt_aspect( output, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_aspect( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_assess_route.Rd b/man/wbt_assess_route.Rd index f61d19e1d..e57374518 100644 --- a/man/wbt_assess_route.Rd +++ b/man/wbt_assess_route.Rd @@ -11,8 +11,8 @@ wbt_assess_route( length = "", dist = 20, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_assess_route( \item{dist}{Search distance, in grid cells, used in visibility analysis.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_atan2.Rd b/man/wbt_atan2.Rd index f3b1c7314..05f8be016 100644 --- a/man/wbt_atan2.Rd +++ b/man/wbt_atan2.Rd @@ -9,8 +9,8 @@ wbt_atan2( input_x, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_atan2( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_attribute_correlation.Rd b/man/wbt_attribute_correlation.Rd index 43ed4d620..7241a410f 100644 --- a/man/wbt_attribute_correlation.Rd +++ b/man/wbt_attribute_correlation.Rd @@ -8,8 +8,8 @@ wbt_attribute_correlation( input, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_attribute_correlation( \item{output}{Output HTML file (default name will be based on input file if unspecified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_attribute_correlation_neighbourhood_analysis.Rd b/man/wbt_attribute_correlation_neighbourhood_analysis.Rd index 8f7b0bbc0..8b7d3596c 100644 --- a/man/wbt_attribute_correlation_neighbourhood_analysis.Rd +++ b/man/wbt_attribute_correlation_neighbourhood_analysis.Rd @@ -12,8 +12,8 @@ wbt_attribute_correlation_neighbourhood_analysis( min_points = NULL, stat = "pearson", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_attribute_correlation_neighbourhood_analysis( \item{stat}{Correlation type; one of 'pearson' (default) and 'spearman'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_attribute_histogram.Rd b/man/wbt_attribute_histogram.Rd index 875570ddc..a0c700d50 100644 --- a/man/wbt_attribute_histogram.Rd +++ b/man/wbt_attribute_histogram.Rd @@ -9,8 +9,8 @@ wbt_attribute_histogram( field, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_attribute_histogram( \item{output}{Output HTML file (default name will be based on input file if unspecified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_attribute_scattergram.Rd b/man/wbt_attribute_scattergram.Rd index 96a4ffc41..316f0672d 100644 --- a/man/wbt_attribute_scattergram.Rd +++ b/man/wbt_attribute_scattergram.Rd @@ -11,8 +11,8 @@ wbt_attribute_scattergram( output, trendline = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_attribute_scattergram( \item{trendline}{Draw the trendline.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_average_flowpath_slope.Rd b/man/wbt_average_flowpath_slope.Rd index 3ab9ebfd0..9b42c55d2 100644 --- a/man/wbt_average_flowpath_slope.Rd +++ b/man/wbt_average_flowpath_slope.Rd @@ -8,8 +8,8 @@ wbt_average_flowpath_slope( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_average_flowpath_slope( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_average_normal_vector_angular_deviation.Rd b/man/wbt_average_normal_vector_angular_deviation.Rd index 26a0d98a2..a1f2750ee 100644 --- a/man/wbt_average_normal_vector_angular_deviation.Rd +++ b/man/wbt_average_normal_vector_angular_deviation.Rd @@ -9,8 +9,8 @@ wbt_average_normal_vector_angular_deviation( output, filter = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_average_normal_vector_angular_deviation( \item{filter}{Size of the filter kernel.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_average_overlay.Rd b/man/wbt_average_overlay.Rd index 95b00a6d8..261514b8c 100644 --- a/man/wbt_average_overlay.Rd +++ b/man/wbt_average_overlay.Rd @@ -8,8 +8,8 @@ wbt_average_overlay( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_average_overlay( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_average_upslope_flowpath_length.Rd b/man/wbt_average_upslope_flowpath_length.Rd index 9d4cc6626..6eee1993d 100644 --- a/man/wbt_average_upslope_flowpath_length.Rd +++ b/man/wbt_average_upslope_flowpath_length.Rd @@ -8,8 +8,8 @@ wbt_average_upslope_flowpath_length( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_average_upslope_flowpath_length( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_balance_contrast_enhancement.Rd b/man/wbt_balance_contrast_enhancement.Rd index aa7907fed..f230a8f09 100644 --- a/man/wbt_balance_contrast_enhancement.Rd +++ b/man/wbt_balance_contrast_enhancement.Rd @@ -9,8 +9,8 @@ wbt_balance_contrast_enhancement( output, band_mean = 100, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_balance_contrast_enhancement( \item{band_mean}{Band mean value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_basins.Rd b/man/wbt_basins.Rd index f25f6a522..41daca716 100644 --- a/man/wbt_basins.Rd +++ b/man/wbt_basins.Rd @@ -9,8 +9,8 @@ wbt_basins( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_basins( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_bilateral_filter.Rd b/man/wbt_bilateral_filter.Rd index 680a94381..7d8fd9309 100644 --- a/man/wbt_bilateral_filter.Rd +++ b/man/wbt_bilateral_filter.Rd @@ -10,8 +10,8 @@ wbt_bilateral_filter( sigma_dist = 0.75, sigma_int = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_bilateral_filter( \item{sigma_int}{Standard deviation in intensity in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_block_maximum_gridding.Rd b/man/wbt_block_maximum_gridding.Rd index fcf9c8f18..de4bd7cf6 100644 --- a/man/wbt_block_maximum_gridding.Rd +++ b/man/wbt_block_maximum_gridding.Rd @@ -12,8 +12,8 @@ wbt_block_maximum_gridding( cell_size = NULL, base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_block_maximum_gridding( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_block_minimum_gridding.Rd b/man/wbt_block_minimum_gridding.Rd index 8b25e6226..73322d89c 100644 --- a/man/wbt_block_minimum_gridding.Rd +++ b/man/wbt_block_minimum_gridding.Rd @@ -12,8 +12,8 @@ wbt_block_minimum_gridding( cell_size = NULL, base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_block_minimum_gridding( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_boundary_shape_complexity.Rd b/man/wbt_boundary_shape_complexity.Rd index ea49426f8..fcc4edafd 100644 --- a/man/wbt_boundary_shape_complexity.Rd +++ b/man/wbt_boundary_shape_complexity.Rd @@ -8,8 +8,8 @@ wbt_boundary_shape_complexity( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_boundary_shape_complexity( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_breach_depressions.Rd b/man/wbt_breach_depressions.Rd index 551b04ce9..b625b1042 100644 --- a/man/wbt_breach_depressions.Rd +++ b/man/wbt_breach_depressions.Rd @@ -12,8 +12,8 @@ wbt_breach_depressions( flat_increment = NULL, fill_pits = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_breach_depressions( \item{fill_pits}{Optional flag indicating whether to fill single-cell pits.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_breach_depressions_least_cost.Rd b/man/wbt_breach_depressions_least_cost.Rd index de6f53f93..b2fe6d668 100644 --- a/man/wbt_breach_depressions_least_cost.Rd +++ b/man/wbt_breach_depressions_least_cost.Rd @@ -13,8 +13,8 @@ wbt_breach_depressions_least_cost( flat_increment = NULL, fill = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_breach_depressions_least_cost( \item{fill}{Optional flag indicating whether to fill any remaining unbreached depressions.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_breach_single_cell_pits.Rd b/man/wbt_breach_single_cell_pits.Rd index 64c6ed9f1..5e9e5df5f 100644 --- a/man/wbt_breach_single_cell_pits.Rd +++ b/man/wbt_breach_single_cell_pits.Rd @@ -8,8 +8,8 @@ wbt_breach_single_cell_pits( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_breach_single_cell_pits( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_breakline_mapping.Rd b/man/wbt_breakline_mapping.Rd index c0414f8ac..a78a69f59 100644 --- a/man/wbt_breakline_mapping.Rd +++ b/man/wbt_breakline_mapping.Rd @@ -10,8 +10,8 @@ wbt_breakline_mapping( threshold = 2, min_length = 3, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_breakline_mapping( \item{min_length}{Minimum line length, in grid cells.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_buffer_raster.Rd b/man/wbt_buffer_raster.Rd index b7f2987c5..f897aedc8 100644 --- a/man/wbt_buffer_raster.Rd +++ b/man/wbt_buffer_raster.Rd @@ -10,8 +10,8 @@ wbt_buffer_raster( size, gridcells = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_buffer_raster( \item{gridcells}{Optional flag to indicate that the 'size' threshold should be measured in grid cells instead of the default map units.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_burn_streams_at_roads.Rd b/man/wbt_burn_streams_at_roads.Rd index 688332c4b..fa5a83884 100644 --- a/man/wbt_burn_streams_at_roads.Rd +++ b/man/wbt_burn_streams_at_roads.Rd @@ -11,8 +11,8 @@ wbt_burn_streams_at_roads( output, width = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_burn_streams_at_roads( \item{width}{Maximum road embankment width, in map units.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_canny_edge_detection.Rd b/man/wbt_canny_edge_detection.Rd index 3eed650f7..f6d4d9e17 100644 --- a/man/wbt_canny_edge_detection.Rd +++ b/man/wbt_canny_edge_detection.Rd @@ -12,8 +12,8 @@ wbt_canny_edge_detection( high = 0.15, add_back = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_canny_edge_detection( \item{add_back}{Add the edge cells back to the input image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_ceil.Rd b/man/wbt_ceil.Rd index 81c858e8d..a5efdc2dc 100644 --- a/man/wbt_ceil.Rd +++ b/man/wbt_ceil.Rd @@ -8,8 +8,8 @@ wbt_ceil( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_ceil( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_centroid.Rd b/man/wbt_centroid.Rd index 40fc2c4f6..eb9918465 100644 --- a/man/wbt_centroid.Rd +++ b/man/wbt_centroid.Rd @@ -9,8 +9,8 @@ wbt_centroid( output, text_output = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_centroid( \item{text_output}{Optional text output.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_centroid_vector.Rd b/man/wbt_centroid_vector.Rd index 2e4aedcd6..635877d72 100644 --- a/man/wbt_centroid_vector.Rd +++ b/man/wbt_centroid_vector.Rd @@ -8,8 +8,8 @@ wbt_centroid_vector( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_centroid_vector( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_change_vector_analysis.Rd b/man/wbt_change_vector_analysis.Rd index 0d6f47fc6..27011cb57 100644 --- a/man/wbt_change_vector_analysis.Rd +++ b/man/wbt_change_vector_analysis.Rd @@ -10,8 +10,8 @@ wbt_change_vector_analysis( magnitude, direction, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_change_vector_analysis( \item{direction}{Output vector Direction raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_circular_variance_of_aspect.Rd b/man/wbt_circular_variance_of_aspect.Rd index 6f1a02a6b..933165410 100644 --- a/man/wbt_circular_variance_of_aspect.Rd +++ b/man/wbt_circular_variance_of_aspect.Rd @@ -9,8 +9,8 @@ wbt_circular_variance_of_aspect( output, filter = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_circular_variance_of_aspect( \item{filter}{Size of the filter kernel.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_classify_buildings_in_lidar.Rd b/man/wbt_classify_buildings_in_lidar.Rd index db1b82bbb..9d5f4e93b 100644 --- a/man/wbt_classify_buildings_in_lidar.Rd +++ b/man/wbt_classify_buildings_in_lidar.Rd @@ -9,8 +9,8 @@ wbt_classify_buildings_in_lidar( buildings, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_classify_buildings_in_lidar( \item{output}{Output LiDAR file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_classify_lidar.Rd b/man/wbt_classify_lidar.Rd index 85da78b4b..3bc082932 100644 --- a/man/wbt_classify_lidar.Rd +++ b/man/wbt_classify_lidar.Rd @@ -15,8 +15,8 @@ wbt_classify_lidar( iterations = 30, facade_threshold = 0.5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_classify_lidar( \item{facade_threshold}{Facade threshold (metres).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_classify_overlap_points.Rd b/man/wbt_classify_overlap_points.Rd index 06006c5a2..02df9e554 100644 --- a/man/wbt_classify_overlap_points.Rd +++ b/man/wbt_classify_overlap_points.Rd @@ -11,8 +11,8 @@ wbt_classify_overlap_points( criterion = "max scan angle", filter = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_classify_overlap_points( \item{filter}{Filter out points from overlapping flightlines? If false, overlaps will simply be classified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_clean_vector.Rd b/man/wbt_clean_vector.Rd index e4259befb..69e889b41 100644 --- a/man/wbt_clean_vector.Rd +++ b/man/wbt_clean_vector.Rd @@ -8,8 +8,8 @@ wbt_clean_vector( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_clean_vector( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_clip.Rd b/man/wbt_clip.Rd index ea3f0a97e..37d183d30 100644 --- a/man/wbt_clip.Rd +++ b/man/wbt_clip.Rd @@ -9,8 +9,8 @@ wbt_clip( clip, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_clip( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_clip_lidar_to_polygon.Rd b/man/wbt_clip_lidar_to_polygon.Rd index f782c3abf..775a659ca 100644 --- a/man/wbt_clip_lidar_to_polygon.Rd +++ b/man/wbt_clip_lidar_to_polygon.Rd @@ -9,8 +9,8 @@ wbt_clip_lidar_to_polygon( polygons, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_clip_lidar_to_polygon( \item{output}{Output LiDAR file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_clip_raster_to_polygon.Rd b/man/wbt_clip_raster_to_polygon.Rd index bcdd975d2..41ae8d691 100644 --- a/man/wbt_clip_raster_to_polygon.Rd +++ b/man/wbt_clip_raster_to_polygon.Rd @@ -10,8 +10,8 @@ wbt_clip_raster_to_polygon( output, maintain_dimensions = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_clip_raster_to_polygon( \item{maintain_dimensions}{Maintain input raster dimensions?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_closing.Rd b/man/wbt_closing.Rd index ca23814b6..94f4f41a9 100644 --- a/man/wbt_closing.Rd +++ b/man/wbt_closing.Rd @@ -10,8 +10,8 @@ wbt_closing( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_closing( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_clump.Rd b/man/wbt_clump.Rd index 26887fdd5..6fb8da6b8 100644 --- a/man/wbt_clump.Rd +++ b/man/wbt_clump.Rd @@ -10,8 +10,8 @@ wbt_clump( diag = TRUE, zero_back = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_clump( \item{zero_back}{Flag indicating whether zero values should be treated as a background.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_colourize_based_on_class.Rd b/man/wbt_colourize_based_on_class.Rd index 606598056..be1379db2 100644 --- a/man/wbt_colourize_based_on_class.Rd +++ b/man/wbt_colourize_based_on_class.Rd @@ -12,8 +12,8 @@ wbt_colourize_based_on_class( use_unique_clrs_for_buildings = FALSE, radius = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_colourize_based_on_class( \item{radius}{Search distance used in neighbourhood search.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_colourize_based_on_point_returns.Rd b/man/wbt_colourize_based_on_point_returns.Rd index d0a5aa1f1..3d7ef58dd 100644 --- a/man/wbt_colourize_based_on_point_returns.Rd +++ b/man/wbt_colourize_based_on_point_returns.Rd @@ -13,8 +13,8 @@ wbt_colourize_based_on_point_returns( intermediate = "(255,0,255)", last = "(0,0,255)", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_colourize_based_on_point_returns( \item{last}{Last return colour, e.g. (230,214,170), #e6d6aa, or 0xe6d6aa.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_compactness_ratio.Rd b/man/wbt_compactness_ratio.Rd index d8be35850..94627c180 100644 --- a/man/wbt_compactness_ratio.Rd +++ b/man/wbt_compactness_ratio.Rd @@ -7,21 +7,21 @@ wbt_compactness_ratio( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_conditional_evaluation.Rd b/man/wbt_conditional_evaluation.Rd index 568a34752..85092769c 100644 --- a/man/wbt_conditional_evaluation.Rd +++ b/man/wbt_conditional_evaluation.Rd @@ -11,8 +11,8 @@ wbt_conditional_evaluation( true = NULL, false = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_conditional_evaluation( \item{false}{Value where condition evaluates FALSE (input raster or constant value).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_conditioned_latin_hypercube.Rd b/man/wbt_conditioned_latin_hypercube.Rd index e28283b35..6a721a364 100644 --- a/man/wbt_conditioned_latin_hypercube.Rd +++ b/man/wbt_conditioned_latin_hypercube.Rd @@ -17,8 +17,8 @@ wbt_conditioned_latin_hypercube( cycle = 10, average = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -45,13 +45,13 @@ wbt_conditioned_latin_hypercube( \item{average}{Weight the continuous objective funtion by the 1/N contributing strata.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_conservative_smoothing_filter.Rd b/man/wbt_conservative_smoothing_filter.Rd index 1470ad3e9..24c165579 100644 --- a/man/wbt_conservative_smoothing_filter.Rd +++ b/man/wbt_conservative_smoothing_filter.Rd @@ -10,8 +10,8 @@ wbt_conservative_smoothing_filter( filterx = 3, filtery = 3, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_conservative_smoothing_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_construct_vector_tin.Rd b/man/wbt_construct_vector_tin.Rd index e02e7b3e9..6fe8c6451 100644 --- a/man/wbt_construct_vector_tin.Rd +++ b/man/wbt_construct_vector_tin.Rd @@ -11,8 +11,8 @@ wbt_construct_vector_tin( use_z = FALSE, max_triangle_edge_length = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_construct_vector_tin( \item{max_triangle_edge_length}{Optional maximum triangle edge length; triangles larger than this size will not be gridded.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_contours_from_points.Rd b/man/wbt_contours_from_points.Rd index a57e0f818..ce02e924e 100644 --- a/man/wbt_contours_from_points.Rd +++ b/man/wbt_contours_from_points.Rd @@ -14,8 +14,8 @@ wbt_contours_from_points( base = 0, smooth = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_contours_from_points( \item{smooth}{Smoothing filter size (in num. points), e.g. 3, 5, 7, 9, 11.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_contours_from_raster.Rd b/man/wbt_contours_from_raster.Rd index 14e222ea2..f8c2da683 100644 --- a/man/wbt_contours_from_raster.Rd +++ b/man/wbt_contours_from_raster.Rd @@ -12,8 +12,8 @@ wbt_contours_from_raster( smooth = 9, tolerance = 10, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_contours_from_raster( \item{tolerance}{Tolerance factor, in degrees (0-45); determines generalization level.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_convert_nodata_to_zero.Rd b/man/wbt_convert_nodata_to_zero.Rd index 1c65782f7..83cef5f9b 100644 --- a/man/wbt_convert_nodata_to_zero.Rd +++ b/man/wbt_convert_nodata_to_zero.Rd @@ -8,8 +8,8 @@ wbt_convert_nodata_to_zero( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_convert_nodata_to_zero( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_convert_raster_format.Rd b/man/wbt_convert_raster_format.Rd index 4cf4908b2..47322e674 100644 --- a/man/wbt_convert_raster_format.Rd +++ b/man/wbt_convert_raster_format.Rd @@ -8,8 +8,8 @@ wbt_convert_raster_format( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_convert_raster_format( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_corner_detection.Rd b/man/wbt_corner_detection.Rd index 5947eee53..896d0bd7b 100644 --- a/man/wbt_corner_detection.Rd +++ b/man/wbt_corner_detection.Rd @@ -8,8 +8,8 @@ wbt_corner_detection( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_corner_detection( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_correct_vignetting.Rd b/man/wbt_correct_vignetting.Rd index d589574ae..823300166 100644 --- a/man/wbt_correct_vignetting.Rd +++ b/man/wbt_correct_vignetting.Rd @@ -12,8 +12,8 @@ wbt_correct_vignetting( image_width = 228.6, n = 4, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_correct_vignetting( \item{n}{The 'n' parameter.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_cos.Rd b/man/wbt_cos.Rd index fc6ab0167..0d564a721 100644 --- a/man/wbt_cos.Rd +++ b/man/wbt_cos.Rd @@ -8,8 +8,8 @@ wbt_cos( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_cos( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_cosh.Rd b/man/wbt_cosh.Rd index de77305a4..1162503c5 100644 --- a/man/wbt_cosh.Rd +++ b/man/wbt_cosh.Rd @@ -8,8 +8,8 @@ wbt_cosh( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_cosh( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_cost_allocation.Rd b/man/wbt_cost_allocation.Rd index 0ef6dbbc6..a08b5297c 100644 --- a/man/wbt_cost_allocation.Rd +++ b/man/wbt_cost_allocation.Rd @@ -9,8 +9,8 @@ wbt_cost_allocation( backlink, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_cost_allocation( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_cost_distance.Rd b/man/wbt_cost_distance.Rd index e89a2bccc..ce08e7cbc 100644 --- a/man/wbt_cost_distance.Rd +++ b/man/wbt_cost_distance.Rd @@ -10,8 +10,8 @@ wbt_cost_distance( out_accum, out_backlink, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_cost_distance( \item{out_backlink}{Output backlink raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_cost_pathway.Rd b/man/wbt_cost_pathway.Rd index 01c9a68c1..118e8e896 100644 --- a/man/wbt_cost_pathway.Rd +++ b/man/wbt_cost_pathway.Rd @@ -10,8 +10,8 @@ wbt_cost_pathway( output, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_cost_pathway( \item{zero_background}{Flag indicating whether zero values should be treated as a background.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_count_if.Rd b/man/wbt_count_if.Rd index d1cb25870..dbcbce5f9 100644 --- a/man/wbt_count_if.Rd +++ b/man/wbt_count_if.Rd @@ -9,8 +9,8 @@ wbt_count_if( output, value, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_count_if( \item{value}{Search value (e.g. countif value = 5.0).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_create_colour_composite.Rd b/man/wbt_create_colour_composite.Rd index 420a759c9..9d5501e4b 100644 --- a/man/wbt_create_colour_composite.Rd +++ b/man/wbt_create_colour_composite.Rd @@ -13,8 +13,8 @@ wbt_create_colour_composite( enhance = TRUE, zeros = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_create_colour_composite( \item{zeros}{Optional flag to indicate if zeros are nodata values.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_create_hexagonal_vector_grid.Rd b/man/wbt_create_hexagonal_vector_grid.Rd index 053dda366..58b31f7b2 100644 --- a/man/wbt_create_hexagonal_vector_grid.Rd +++ b/man/wbt_create_hexagonal_vector_grid.Rd @@ -10,8 +10,8 @@ wbt_create_hexagonal_vector_grid( width, orientation = "horizontal", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_create_hexagonal_vector_grid( \item{orientation}{Grid Orientation, 'horizontal' or 'vertical'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_create_plane.Rd b/man/wbt_create_plane.Rd index 77537f87a..1c5548e66 100644 --- a/man/wbt_create_plane.Rd +++ b/man/wbt_create_plane.Rd @@ -11,8 +11,8 @@ wbt_create_plane( aspect = 90, constant = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_create_plane( \item{constant}{Constant value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_create_rectangular_vector_grid.Rd b/man/wbt_create_rectangular_vector_grid.Rd index 9a16c2a07..03bae410f 100644 --- a/man/wbt_create_rectangular_vector_grid.Rd +++ b/man/wbt_create_rectangular_vector_grid.Rd @@ -12,8 +12,8 @@ wbt_create_rectangular_vector_grid( xorig = 0, yorig = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_create_rectangular_vector_grid( \item{yorig}{The grid origin y-coordinate.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_crispness_index.Rd b/man/wbt_crispness_index.Rd index 81930e097..b5bc086c9 100644 --- a/man/wbt_crispness_index.Rd +++ b/man/wbt_crispness_index.Rd @@ -8,8 +8,8 @@ wbt_crispness_index( input, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_crispness_index( \item{output}{Optional output html file (default name will be based on input file if unspecified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_cross_tabulation.Rd b/man/wbt_cross_tabulation.Rd index 3ef23687d..072a8aea2 100644 --- a/man/wbt_cross_tabulation.Rd +++ b/man/wbt_cross_tabulation.Rd @@ -9,8 +9,8 @@ wbt_cross_tabulation( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_cross_tabulation( \item{output}{Output HTML file (default name will be based on input file if unspecified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_csv_points_to_vector.Rd b/man/wbt_csv_points_to_vector.Rd index f571672d6..dfe8e6711 100644 --- a/man/wbt_csv_points_to_vector.Rd +++ b/man/wbt_csv_points_to_vector.Rd @@ -11,8 +11,8 @@ wbt_csv_points_to_vector( yfield = 1, epsg = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_csv_points_to_vector( \item{epsg}{EPSG projection (e.g. 2958).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_cumulative_distribution.Rd b/man/wbt_cumulative_distribution.Rd index 29b5c6850..90d5f5a6f 100644 --- a/man/wbt_cumulative_distribution.Rd +++ b/man/wbt_cumulative_distribution.Rd @@ -8,8 +8,8 @@ wbt_cumulative_distribution( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_cumulative_distribution( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_curvedness.Rd b/man/wbt_curvedness.Rd index a3f4870ad..dee555a7b 100644 --- a/man/wbt_curvedness.Rd +++ b/man/wbt_curvedness.Rd @@ -10,8 +10,8 @@ wbt_curvedness( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_curvedness( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_d8_flow_accumulation.Rd b/man/wbt_d8_flow_accumulation.Rd index a379123e0..2565cdde1 100644 --- a/man/wbt_d8_flow_accumulation.Rd +++ b/man/wbt_d8_flow_accumulation.Rd @@ -13,8 +13,8 @@ wbt_d8_flow_accumulation( pntr = FALSE, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_d8_flow_accumulation( \item{esri_pntr}{Input D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_d8_mass_flux.Rd b/man/wbt_d8_mass_flux.Rd index 24468e5c2..84e7a3544 100644 --- a/man/wbt_d8_mass_flux.Rd +++ b/man/wbt_d8_mass_flux.Rd @@ -11,8 +11,8 @@ wbt_d8_mass_flux( absorption, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_d8_mass_flux( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_d8_pointer.Rd b/man/wbt_d8_pointer.Rd index a7ce28c80..c22ec3879 100644 --- a/man/wbt_d8_pointer.Rd +++ b/man/wbt_d8_pointer.Rd @@ -9,8 +9,8 @@ wbt_d8_pointer( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_d8_pointer( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_d_inf_flow_accumulation.Rd b/man/wbt_d_inf_flow_accumulation.Rd index f241dec78..b4199ba9f 100644 --- a/man/wbt_d_inf_flow_accumulation.Rd +++ b/man/wbt_d_inf_flow_accumulation.Rd @@ -13,8 +13,8 @@ wbt_d_inf_flow_accumulation( clip = FALSE, pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_d_inf_flow_accumulation( \item{pntr}{Is the input raster a D-infinity flow pointer rather than a DEM?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_d_inf_mass_flux.Rd b/man/wbt_d_inf_mass_flux.Rd index d7de700ca..c8565902f 100644 --- a/man/wbt_d_inf_mass_flux.Rd +++ b/man/wbt_d_inf_mass_flux.Rd @@ -11,8 +11,8 @@ wbt_d_inf_mass_flux( absorption, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_d_inf_mass_flux( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_d_inf_pointer.Rd b/man/wbt_d_inf_pointer.Rd index 42bf47115..32177fbdb 100644 --- a/man/wbt_d_inf_pointer.Rd +++ b/man/wbt_d_inf_pointer.Rd @@ -8,8 +8,8 @@ wbt_d_inf_pointer( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_d_inf_pointer( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_dbscan.Rd b/man/wbt_dbscan.Rd index 057fd4be4..0c089ca53 100644 --- a/man/wbt_dbscan.Rd +++ b/man/wbt_dbscan.Rd @@ -11,8 +11,8 @@ wbt_dbscan( search_dist = 0.01, min_points = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_dbscan( \item{min_points}{Minimum point density needed to define 'core' point in cluster.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_decrement.Rd b/man/wbt_decrement.Rd index fa1851a5b..cabe599ac 100644 --- a/man/wbt_decrement.Rd +++ b/man/wbt_decrement.Rd @@ -8,8 +8,8 @@ wbt_decrement( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_decrement( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_dem_void_filling.Rd b/man/wbt_dem_void_filling.Rd index be8370049..a256e9273 100644 --- a/man/wbt_dem_void_filling.Rd +++ b/man/wbt_dem_void_filling.Rd @@ -12,8 +12,8 @@ wbt_dem_void_filling( edge_treatment = "use DEM", weight_value = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_dem_void_filling( \item{weight_value}{Weight value used for IDW interpolation (default is 2.0).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_depth_in_sink.Rd b/man/wbt_depth_in_sink.Rd index 1c1e9b34c..3fe949511 100644 --- a/man/wbt_depth_in_sink.Rd +++ b/man/wbt_depth_in_sink.Rd @@ -9,8 +9,8 @@ wbt_depth_in_sink( output, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_depth_in_sink( \item{zero_background}{Flag indicating whether the background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_depth_to_water.Rd b/man/wbt_depth_to_water.Rd index 191edf909..dcd62baca 100644 --- a/man/wbt_depth_to_water.Rd +++ b/man/wbt_depth_to_water.Rd @@ -10,8 +10,8 @@ wbt_depth_to_water( streams = NULL, lakes = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_depth_to_water( \item{lakes}{Name of the input lakes vector (optional).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_dev_from_mean_elev.Rd b/man/wbt_dev_from_mean_elev.Rd index 33369274a..e10cfb9be 100644 --- a/man/wbt_dev_from_mean_elev.Rd +++ b/man/wbt_dev_from_mean_elev.Rd @@ -10,8 +10,8 @@ wbt_dev_from_mean_elev( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_dev_from_mean_elev( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_diff_from_mean_elev.Rd b/man/wbt_diff_from_mean_elev.Rd index b1135b6e0..16ac730c1 100644 --- a/man/wbt_diff_from_mean_elev.Rd +++ b/man/wbt_diff_from_mean_elev.Rd @@ -10,8 +10,8 @@ wbt_diff_from_mean_elev( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_diff_from_mean_elev( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_diff_of_gaussian_filter.Rd b/man/wbt_diff_of_gaussian_filter.Rd index ea4c51141..0b8b526b7 100644 --- a/man/wbt_diff_of_gaussian_filter.Rd +++ b/man/wbt_diff_of_gaussian_filter.Rd @@ -10,8 +10,8 @@ wbt_diff_of_gaussian_filter( sigma1 = 2, sigma2 = 4, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_diff_of_gaussian_filter( \item{sigma2}{Standard deviation distance in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_difference.Rd b/man/wbt_difference.Rd index 1b21c93aa..c2d1ecd6a 100644 --- a/man/wbt_difference.Rd +++ b/man/wbt_difference.Rd @@ -9,8 +9,8 @@ wbt_difference( overlay, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_difference( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_difference_curvature.Rd b/man/wbt_difference_curvature.Rd index 4e8489c22..1abdacb47 100644 --- a/man/wbt_difference_curvature.Rd +++ b/man/wbt_difference_curvature.Rd @@ -10,8 +10,8 @@ wbt_difference_curvature( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_difference_curvature( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_direct_decorrelation_stretch.Rd b/man/wbt_direct_decorrelation_stretch.Rd index 978a2bacd..53a9098be 100644 --- a/man/wbt_direct_decorrelation_stretch.Rd +++ b/man/wbt_direct_decorrelation_stretch.Rd @@ -10,8 +10,8 @@ wbt_direct_decorrelation_stretch( k = 0.5, clip = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_direct_decorrelation_stretch( \item{clip}{Optional percent to clip the upper tail by during the stretch.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_directional_relief.Rd b/man/wbt_directional_relief.Rd index f9325df5f..1d1c30e66 100644 --- a/man/wbt_directional_relief.Rd +++ b/man/wbt_directional_relief.Rd @@ -10,8 +10,8 @@ wbt_directional_relief( azimuth = 0, max_dist = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_directional_relief( \item{max_dist}{Optional maximum search distance (unspecified if none; in xy units).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_dissolve.Rd b/man/wbt_dissolve.Rd index 06b349c07..6244a941b 100644 --- a/man/wbt_dissolve.Rd +++ b/man/wbt_dissolve.Rd @@ -10,8 +10,8 @@ wbt_dissolve( field = NULL, snap = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_dissolve( \item{snap}{Snap tolerance.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_distance_to_outlet.Rd b/man/wbt_distance_to_outlet.Rd index 692d68234..77297c0b4 100644 --- a/man/wbt_distance_to_outlet.Rd +++ b/man/wbt_distance_to_outlet.Rd @@ -11,8 +11,8 @@ wbt_distance_to_outlet( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_distance_to_outlet( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_diversity_filter.Rd b/man/wbt_diversity_filter.Rd index f5789143c..c7847fae2 100644 --- a/man/wbt_diversity_filter.Rd +++ b/man/wbt_diversity_filter.Rd @@ -10,8 +10,8 @@ wbt_diversity_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_diversity_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_divide.Rd b/man/wbt_divide.Rd index bcbb9b379..390607cf5 100644 --- a/man/wbt_divide.Rd +++ b/man/wbt_divide.Rd @@ -9,8 +9,8 @@ wbt_divide( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_divide( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_downslope_distance_to_stream.Rd b/man/wbt_downslope_distance_to_stream.Rd index 287ef9e6f..19f773036 100644 --- a/man/wbt_downslope_distance_to_stream.Rd +++ b/man/wbt_downslope_distance_to_stream.Rd @@ -10,8 +10,8 @@ wbt_downslope_distance_to_stream( output, dinf = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_downslope_distance_to_stream( \item{dinf}{Use the D-infinity flow algorithm instead of D8?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_downslope_flowpath_length.Rd b/man/wbt_downslope_flowpath_length.Rd index 619e62843..a377e168b 100644 --- a/man/wbt_downslope_flowpath_length.Rd +++ b/man/wbt_downslope_flowpath_length.Rd @@ -11,8 +11,8 @@ wbt_downslope_flowpath_length( weights = NULL, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_downslope_flowpath_length( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_downslope_index.Rd b/man/wbt_downslope_index.Rd index 2d5833cfa..fbebedb62 100644 --- a/man/wbt_downslope_index.Rd +++ b/man/wbt_downslope_index.Rd @@ -10,8 +10,8 @@ wbt_downslope_index( drop = 2, out_type = "tangent", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_downslope_index( \item{out_type}{Output type, options include 'tangent', 'degrees', 'radians', 'distance' (default is 'tangent').} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_edge_contamination.Rd b/man/wbt_edge_contamination.Rd index 1876f46d6..87f1d67aa 100644 --- a/man/wbt_edge_contamination.Rd +++ b/man/wbt_edge_contamination.Rd @@ -10,8 +10,8 @@ wbt_edge_contamination( flow_type = "mfd", zfactor = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_edge_contamination( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_edge_density.Rd b/man/wbt_edge_density.Rd index 346a77996..936cd0c2c 100644 --- a/man/wbt_edge_density.Rd +++ b/man/wbt_edge_density.Rd @@ -11,8 +11,8 @@ wbt_edge_density( norm_diff = 5, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_edge_density( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_edge_preserving_mean_filter.Rd b/man/wbt_edge_preserving_mean_filter.Rd index a6c542bea..531d02cc2 100644 --- a/man/wbt_edge_preserving_mean_filter.Rd +++ b/man/wbt_edge_preserving_mean_filter.Rd @@ -10,8 +10,8 @@ wbt_edge_preserving_mean_filter( threshold, filter = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_edge_preserving_mean_filter( \item{filter}{Size of the filter kernel.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_edge_proportion.Rd b/man/wbt_edge_proportion.Rd index adb8603e0..1a91e73d2 100644 --- a/man/wbt_edge_proportion.Rd +++ b/man/wbt_edge_proportion.Rd @@ -9,8 +9,8 @@ wbt_edge_proportion( output, output_text = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_edge_proportion( \item{output_text}{flag indicating whether a text report should also be output.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_elev_above_pit.Rd b/man/wbt_elev_above_pit.Rd index 7b7f1831b..6c56e7f4f 100644 --- a/man/wbt_elev_above_pit.Rd +++ b/man/wbt_elev_above_pit.Rd @@ -8,8 +8,8 @@ wbt_elev_above_pit( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_elev_above_pit( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_elev_percentile.Rd b/man/wbt_elev_percentile.Rd index 148cfaf75..4018e1453 100644 --- a/man/wbt_elev_percentile.Rd +++ b/man/wbt_elev_percentile.Rd @@ -11,8 +11,8 @@ wbt_elev_percentile( filtery = 11, sig_digits = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_elev_percentile( \item{sig_digits}{Number of significant digits.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_elev_relative_to_min_max.Rd b/man/wbt_elev_relative_to_min_max.Rd index b742395e2..b0e68dbce 100644 --- a/man/wbt_elev_relative_to_min_max.Rd +++ b/man/wbt_elev_relative_to_min_max.Rd @@ -8,8 +8,8 @@ wbt_elev_relative_to_min_max( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_elev_relative_to_min_max( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_elev_relative_to_watershed_min_max.Rd b/man/wbt_elev_relative_to_watershed_min_max.Rd index 869ba85ff..1ea2190c7 100644 --- a/man/wbt_elev_relative_to_watershed_min_max.Rd +++ b/man/wbt_elev_relative_to_watershed_min_max.Rd @@ -9,8 +9,8 @@ wbt_elev_relative_to_watershed_min_max( watersheds, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_elev_relative_to_watershed_min_max( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_elevation_above_stream.Rd b/man/wbt_elevation_above_stream.Rd index 858484fd1..7db312eb9 100644 --- a/man/wbt_elevation_above_stream.Rd +++ b/man/wbt_elevation_above_stream.Rd @@ -9,8 +9,8 @@ wbt_elevation_above_stream( streams, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_elevation_above_stream( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_elevation_above_stream_euclidean.Rd b/man/wbt_elevation_above_stream_euclidean.Rd index 08729d6cd..b41a0b00b 100644 --- a/man/wbt_elevation_above_stream_euclidean.Rd +++ b/man/wbt_elevation_above_stream_euclidean.Rd @@ -9,8 +9,8 @@ wbt_elevation_above_stream_euclidean( streams, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_elevation_above_stream_euclidean( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_eliminate_coincident_points.Rd b/man/wbt_eliminate_coincident_points.Rd index cdfea5cdd..75e01c860 100644 --- a/man/wbt_eliminate_coincident_points.Rd +++ b/man/wbt_eliminate_coincident_points.Rd @@ -9,8 +9,8 @@ wbt_eliminate_coincident_points( output, tolerance, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_eliminate_coincident_points( \item{tolerance}{The distance tolerance for points.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_elongation_ratio.Rd b/man/wbt_elongation_ratio.Rd index ffd0677cc..48046e333 100644 --- a/man/wbt_elongation_ratio.Rd +++ b/man/wbt_elongation_ratio.Rd @@ -7,21 +7,21 @@ wbt_elongation_ratio( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_embankment_mapping.Rd b/man/wbt_embankment_mapping.Rd index f0f0bde16..0a08c7b26 100644 --- a/man/wbt_embankment_mapping.Rd +++ b/man/wbt_embankment_mapping.Rd @@ -17,8 +17,8 @@ wbt_embankment_mapping( spillout_slope = 4, remove_embankments = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -45,13 +45,13 @@ wbt_embankment_mapping( \item{remove_embankments}{Optional flag indicating whether to output a DEM with embankments removed (true) or an embankment raster map (false).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_emboss_filter.Rd b/man/wbt_emboss_filter.Rd index af4f6d00a..28d433294 100644 --- a/man/wbt_emboss_filter.Rd +++ b/man/wbt_emboss_filter.Rd @@ -10,8 +10,8 @@ wbt_emboss_filter( direction = "n", clip = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_emboss_filter( \item{clip}{Optional amount to clip the distribution tails by, in percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_equal_to.Rd b/man/wbt_equal_to.Rd index 4d4b082d8..8c5f8057d 100644 --- a/man/wbt_equal_to.Rd +++ b/man/wbt_equal_to.Rd @@ -9,8 +9,8 @@ wbt_equal_to( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_equal_to( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_erase.Rd b/man/wbt_erase.Rd index 9584bfbe8..8e71c5dba 100644 --- a/man/wbt_erase.Rd +++ b/man/wbt_erase.Rd @@ -9,8 +9,8 @@ wbt_erase( erase, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_erase( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_erase_polygon_from_lidar.Rd b/man/wbt_erase_polygon_from_lidar.Rd index 6426b2b0f..33d3d5eba 100644 --- a/man/wbt_erase_polygon_from_lidar.Rd +++ b/man/wbt_erase_polygon_from_lidar.Rd @@ -9,8 +9,8 @@ wbt_erase_polygon_from_lidar( polygons, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_erase_polygon_from_lidar( \item{output}{Output LiDAR file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_erase_polygon_from_raster.Rd b/man/wbt_erase_polygon_from_raster.Rd index cdc7ddb35..c3231057c 100644 --- a/man/wbt_erase_polygon_from_raster.Rd +++ b/man/wbt_erase_polygon_from_raster.Rd @@ -9,8 +9,8 @@ wbt_erase_polygon_from_raster( polygons, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_erase_polygon_from_raster( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_euclidean_allocation.Rd b/man/wbt_euclidean_allocation.Rd index 6326a8e0f..ec8448742 100644 --- a/man/wbt_euclidean_allocation.Rd +++ b/man/wbt_euclidean_allocation.Rd @@ -8,8 +8,8 @@ wbt_euclidean_allocation( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_euclidean_allocation( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_euclidean_distance.Rd b/man/wbt_euclidean_distance.Rd index d3355d127..8cde40abb 100644 --- a/man/wbt_euclidean_distance.Rd +++ b/man/wbt_euclidean_distance.Rd @@ -8,8 +8,8 @@ wbt_euclidean_distance( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_euclidean_distance( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_evaluate_training_sites.Rd b/man/wbt_evaluate_training_sites.Rd index 6ab32186b..69cba5c6f 100644 --- a/man/wbt_evaluate_training_sites.Rd +++ b/man/wbt_evaluate_training_sites.Rd @@ -10,8 +10,8 @@ wbt_evaluate_training_sites( field, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_evaluate_training_sites( \item{output}{Name of the output report file (*.html).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_exp.Rd b/man/wbt_exp.Rd index a2ca4dfdc..60e7b744b 100644 --- a/man/wbt_exp.Rd +++ b/man/wbt_exp.Rd @@ -8,8 +8,8 @@ wbt_exp( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_exp( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_exp2.Rd b/man/wbt_exp2.Rd index c457d0de5..fc6c74ccd 100644 --- a/man/wbt_exp2.Rd +++ b/man/wbt_exp2.Rd @@ -8,8 +8,8 @@ wbt_exp2( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_exp2( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_export_table_to_csv.Rd b/man/wbt_export_table_to_csv.Rd index f505b4f65..0726bdbd7 100644 --- a/man/wbt_export_table_to_csv.Rd +++ b/man/wbt_export_table_to_csv.Rd @@ -9,8 +9,8 @@ wbt_export_table_to_csv( output, headers = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_export_table_to_csv( \item{headers}{Export field names as file header?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_exposure_towards_wind_flux.Rd b/man/wbt_exposure_towards_wind_flux.Rd index 6f8f94b85..4d550087b 100644 --- a/man/wbt_exposure_towards_wind_flux.Rd +++ b/man/wbt_exposure_towards_wind_flux.Rd @@ -11,8 +11,8 @@ wbt_exposure_towards_wind_flux( max_dist = "", zfactor = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_exposure_towards_wind_flux( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_extend_vector_lines.Rd b/man/wbt_extend_vector_lines.Rd index c54a04614..9832c56cc 100644 --- a/man/wbt_extend_vector_lines.Rd +++ b/man/wbt_extend_vector_lines.Rd @@ -10,8 +10,8 @@ wbt_extend_vector_lines( dist, extend = "both ends", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_extend_vector_lines( \item{extend}{Extend direction, 'both ends' (default), 'line start', 'line end'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_extract_nodes.Rd b/man/wbt_extract_nodes.Rd index 6182374ad..33f773e0f 100644 --- a/man/wbt_extract_nodes.Rd +++ b/man/wbt_extract_nodes.Rd @@ -8,8 +8,8 @@ wbt_extract_nodes( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_extract_nodes( \item{output}{Output vector points file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_extract_raster_values_at_points.Rd b/man/wbt_extract_raster_values_at_points.Rd index 37d01cc87..0c085cb8d 100644 --- a/man/wbt_extract_raster_values_at_points.Rd +++ b/man/wbt_extract_raster_values_at_points.Rd @@ -9,8 +9,8 @@ wbt_extract_raster_values_at_points( points, out_text = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_extract_raster_values_at_points( \item{out_text}{Output point values as text? Otherwise, the only output is to to the points file's attribute table.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_extract_streams.Rd b/man/wbt_extract_streams.Rd index 4fac247bc..c8283c45f 100644 --- a/man/wbt_extract_streams.Rd +++ b/man/wbt_extract_streams.Rd @@ -10,8 +10,8 @@ wbt_extract_streams( threshold, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_extract_streams( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_extract_valleys.Rd b/man/wbt_extract_valleys.Rd index 0d2a642a9..d87f4f1d3 100644 --- a/man/wbt_extract_valleys.Rd +++ b/man/wbt_extract_valleys.Rd @@ -11,8 +11,8 @@ wbt_extract_valleys( line_thin = TRUE, filter = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_extract_valleys( \item{filter}{Optional argument (only used when variant='lq') providing the filter size, in grid cells, used for lq-filtering (default is 5).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_farthest_channel_head.Rd b/man/wbt_farthest_channel_head.Rd index e03a4e006..43b81afad 100644 --- a/man/wbt_farthest_channel_head.Rd +++ b/man/wbt_farthest_channel_head.Rd @@ -11,8 +11,8 @@ wbt_farthest_channel_head( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_farthest_channel_head( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fast_almost_gaussian_filter.Rd b/man/wbt_fast_almost_gaussian_filter.Rd index 31ee3d218..fe2b8faf9 100644 --- a/man/wbt_fast_almost_gaussian_filter.Rd +++ b/man/wbt_fast_almost_gaussian_filter.Rd @@ -9,8 +9,8 @@ wbt_fast_almost_gaussian_filter( output, sigma = 1.8, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_fast_almost_gaussian_filter( \item{sigma}{Standard deviation distance in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fd8_flow_accumulation.Rd b/man/wbt_fd8_flow_accumulation.Rd index 0c3b23da1..e4622476b 100644 --- a/man/wbt_fd8_flow_accumulation.Rd +++ b/man/wbt_fd8_flow_accumulation.Rd @@ -13,8 +13,8 @@ wbt_fd8_flow_accumulation( log = FALSE, clip = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_fd8_flow_accumulation( \item{clip}{Optional flag to request clipping the display max by 1 percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fd8_pointer.Rd b/man/wbt_fd8_pointer.Rd index bdceecf37..e3e51452c 100644 --- a/man/wbt_fd8_pointer.Rd +++ b/man/wbt_fd8_pointer.Rd @@ -8,8 +8,8 @@ wbt_fd8_pointer( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_fd8_pointer( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_feature_preserving_smoothing.Rd b/man/wbt_feature_preserving_smoothing.Rd index 464bdbfcb..6b3079bad 100644 --- a/man/wbt_feature_preserving_smoothing.Rd +++ b/man/wbt_feature_preserving_smoothing.Rd @@ -13,8 +13,8 @@ wbt_feature_preserving_smoothing( max_diff = 0.5, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_feature_preserving_smoothing( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fetch_analysis.Rd b/man/wbt_fetch_analysis.Rd index 031732987..f49998440 100644 --- a/man/wbt_fetch_analysis.Rd +++ b/man/wbt_fetch_analysis.Rd @@ -10,8 +10,8 @@ wbt_fetch_analysis( azimuth = 0, hgt_inc = 0.05, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_fetch_analysis( \item{hgt_inc}{Height increment value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fill_burn.Rd b/man/wbt_fill_burn.Rd index 08984dbd1..754fd5bad 100644 --- a/man/wbt_fill_burn.Rd +++ b/man/wbt_fill_burn.Rd @@ -9,8 +9,8 @@ wbt_fill_burn( streams, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_fill_burn( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fill_depressions.Rd b/man/wbt_fill_depressions.Rd index 94dd484fe..d5c9d2253 100644 --- a/man/wbt_fill_depressions.Rd +++ b/man/wbt_fill_depressions.Rd @@ -11,8 +11,8 @@ wbt_fill_depressions( flat_increment = NULL, max_depth = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_fill_depressions( \item{max_depth}{Optional maximum depression depth to fill.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fill_depressions_planchon_and_darboux.Rd b/man/wbt_fill_depressions_planchon_and_darboux.Rd index b2191aa02..e9bbe4eca 100644 --- a/man/wbt_fill_depressions_planchon_and_darboux.Rd +++ b/man/wbt_fill_depressions_planchon_and_darboux.Rd @@ -10,8 +10,8 @@ wbt_fill_depressions_planchon_and_darboux( fix_flats = TRUE, flat_increment = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_fill_depressions_planchon_and_darboux( \item{flat_increment}{Optional elevation increment applied to flat areas.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fill_depressions_wang_and_liu.Rd b/man/wbt_fill_depressions_wang_and_liu.Rd index fabbbbb13..517ee5c66 100644 --- a/man/wbt_fill_depressions_wang_and_liu.Rd +++ b/man/wbt_fill_depressions_wang_and_liu.Rd @@ -10,8 +10,8 @@ wbt_fill_depressions_wang_and_liu( fix_flats = TRUE, flat_increment = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_fill_depressions_wang_and_liu( \item{flat_increment}{Optional elevation increment applied to flat areas.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fill_missing_data.Rd b/man/wbt_fill_missing_data.Rd index ee7534408..b03f8c663 100644 --- a/man/wbt_fill_missing_data.Rd +++ b/man/wbt_fill_missing_data.Rd @@ -11,8 +11,8 @@ wbt_fill_missing_data( weight = 2, no_edges = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_fill_missing_data( \item{no_edges}{Optional flag indicating whether to exclude NoData cells in edge regions.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fill_single_cell_pits.Rd b/man/wbt_fill_single_cell_pits.Rd index 4989e15c8..bfea68b66 100644 --- a/man/wbt_fill_single_cell_pits.Rd +++ b/man/wbt_fill_single_cell_pits.Rd @@ -8,8 +8,8 @@ wbt_fill_single_cell_pits( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_fill_single_cell_pits( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_filter_lidar.Rd b/man/wbt_filter_lidar.Rd index 7007bca5a..912bbd5bb 100644 --- a/man/wbt_filter_lidar.Rd +++ b/man/wbt_filter_lidar.Rd @@ -9,8 +9,8 @@ wbt_filter_lidar( output = NULL, statement = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_filter_lidar( \item{statement}{Filter statement e.g. x < 5000.0 && y > 100.0 && is_late && !is_noise. This statement must be a valid Rust statement.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_filter_lidar_classes.Rd b/man/wbt_filter_lidar_classes.Rd index 12bc16940..cdb9e279f 100644 --- a/man/wbt_filter_lidar_classes.Rd +++ b/man/wbt_filter_lidar_classes.Rd @@ -9,8 +9,8 @@ wbt_filter_lidar_classes( output, exclude_cls = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_filter_lidar_classes( \item{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'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_filter_lidar_scan_angles.Rd b/man/wbt_filter_lidar_scan_angles.Rd index d53ccb7d1..28921471a 100644 --- a/man/wbt_filter_lidar_scan_angles.Rd +++ b/man/wbt_filter_lidar_scan_angles.Rd @@ -9,8 +9,8 @@ wbt_filter_lidar_scan_angles( output, threshold, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_filter_lidar_scan_angles( \item{threshold}{Scan angle threshold.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_filter_raster_features_by_area.Rd b/man/wbt_filter_raster_features_by_area.Rd index e2ded1867..6e2b3da35 100644 --- a/man/wbt_filter_raster_features_by_area.Rd +++ b/man/wbt_filter_raster_features_by_area.Rd @@ -10,8 +10,8 @@ wbt_filter_raster_features_by_area( threshold, background = "zero", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_filter_raster_features_by_area( \item{background}{Background value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_find_flightline_edge_points.Rd b/man/wbt_find_flightline_edge_points.Rd index 66d4b972c..7e87fbccf 100644 --- a/man/wbt_find_flightline_edge_points.Rd +++ b/man/wbt_find_flightline_edge_points.Rd @@ -8,8 +8,8 @@ wbt_find_flightline_edge_points( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_find_flightline_edge_points( \item{output}{Output file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_find_lowest_or_highest_points.Rd b/man/wbt_find_lowest_or_highest_points.Rd index 51294923f..c6e775c04 100644 --- a/man/wbt_find_lowest_or_highest_points.Rd +++ b/man/wbt_find_lowest_or_highest_points.Rd @@ -9,8 +9,8 @@ wbt_find_lowest_or_highest_points( output, out_type = "lowest", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_find_lowest_or_highest_points( \item{out_type}{Output type; one of 'area' (default) and 'volume'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_find_main_stem.Rd b/man/wbt_find_main_stem.Rd index 355601e85..7fbd2da9b 100644 --- a/man/wbt_find_main_stem.Rd +++ b/man/wbt_find_main_stem.Rd @@ -11,8 +11,8 @@ wbt_find_main_stem( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_find_main_stem( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_find_no_flow_cells.Rd b/man/wbt_find_no_flow_cells.Rd index c8821cc0c..793253c88 100644 --- a/man/wbt_find_no_flow_cells.Rd +++ b/man/wbt_find_no_flow_cells.Rd @@ -8,8 +8,8 @@ wbt_find_no_flow_cells( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_find_no_flow_cells( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_find_parallel_flow.Rd b/man/wbt_find_parallel_flow.Rd index 2fd5cf802..4b85ba4bf 100644 --- a/man/wbt_find_parallel_flow.Rd +++ b/man/wbt_find_parallel_flow.Rd @@ -9,8 +9,8 @@ wbt_find_parallel_flow( streams, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_find_parallel_flow( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_find_patch_or_class_edge_cells.Rd b/man/wbt_find_patch_or_class_edge_cells.Rd index 122a2da17..45b7ca82e 100644 --- a/man/wbt_find_patch_or_class_edge_cells.Rd +++ b/man/wbt_find_patch_or_class_edge_cells.Rd @@ -8,8 +8,8 @@ wbt_find_patch_or_class_edge_cells( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_find_patch_or_class_edge_cells( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_find_ridges.Rd b/man/wbt_find_ridges.Rd index aa368cf5b..049af881d 100644 --- a/man/wbt_find_ridges.Rd +++ b/man/wbt_find_ridges.Rd @@ -9,8 +9,8 @@ wbt_find_ridges( output, line_thin = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_find_ridges( \item{line_thin}{Optional flag indicating whether post-processing line-thinning should be performed.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_fix_dangling_arcs.Rd b/man/wbt_fix_dangling_arcs.Rd index 63508a5ab..fcd65fef4 100644 --- a/man/wbt_fix_dangling_arcs.Rd +++ b/man/wbt_fix_dangling_arcs.Rd @@ -9,8 +9,8 @@ wbt_fix_dangling_arcs( output, dist = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_fix_dangling_arcs( \item{dist}{Snap distance, in xy units (metres).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_flatten_lakes.Rd b/man/wbt_flatten_lakes.Rd index b09770ebd..ad825da5c 100644 --- a/man/wbt_flatten_lakes.Rd +++ b/man/wbt_flatten_lakes.Rd @@ -9,8 +9,8 @@ wbt_flatten_lakes( lakes, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_flatten_lakes( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_flightline_overlap.Rd b/man/wbt_flightline_overlap.Rd index 2c93e190d..7e0e03510 100644 --- a/man/wbt_flightline_overlap.Rd +++ b/man/wbt_flightline_overlap.Rd @@ -9,8 +9,8 @@ wbt_flightline_overlap( output = NULL, resolution = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_flightline_overlap( \item{resolution}{Output raster's grid resolution.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_flip_image.Rd b/man/wbt_flip_image.Rd index fb5eafbc8..13688a13c 100644 --- a/man/wbt_flip_image.Rd +++ b/man/wbt_flip_image.Rd @@ -9,8 +9,8 @@ wbt_flip_image( output, direction = "vertical", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_flip_image( \item{direction}{Direction of reflection; options include 'v' (vertical), 'h' (horizontal), and 'b' (both).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_flood_order.Rd b/man/wbt_flood_order.Rd index 17c8cbd71..98258db27 100644 --- a/man/wbt_flood_order.Rd +++ b/man/wbt_flood_order.Rd @@ -8,8 +8,8 @@ wbt_flood_order( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_flood_order( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_floor.Rd b/man/wbt_floor.Rd index ca81765f3..09844f3b6 100644 --- a/man/wbt_floor.Rd +++ b/man/wbt_floor.Rd @@ -8,8 +8,8 @@ wbt_floor( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_floor( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_flow_accumulation_full_workflow.Rd b/man/wbt_flow_accumulation_full_workflow.Rd index 4ddd05c09..4f5f07ada 100644 --- a/man/wbt_flow_accumulation_full_workflow.Rd +++ b/man/wbt_flow_accumulation_full_workflow.Rd @@ -14,8 +14,8 @@ wbt_flow_accumulation_full_workflow( clip = FALSE, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_flow_accumulation_full_workflow( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_flow_length_diff.Rd b/man/wbt_flow_length_diff.Rd index a32034f4f..7f9ddb4ed 100644 --- a/man/wbt_flow_length_diff.Rd +++ b/man/wbt_flow_length_diff.Rd @@ -9,8 +9,8 @@ wbt_flow_length_diff( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_flow_length_diff( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_gamma_correction.Rd b/man/wbt_gamma_correction.Rd index c6ac0628c..e96d0febe 100644 --- a/man/wbt_gamma_correction.Rd +++ b/man/wbt_gamma_correction.Rd @@ -9,8 +9,8 @@ wbt_gamma_correction( output, gamma = 0.5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_gamma_correction( \item{gamma}{Gamma value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_gaussian_contrast_stretch.Rd b/man/wbt_gaussian_contrast_stretch.Rd index 466ca0eb0..31bb4109e 100644 --- a/man/wbt_gaussian_contrast_stretch.Rd +++ b/man/wbt_gaussian_contrast_stretch.Rd @@ -9,8 +9,8 @@ wbt_gaussian_contrast_stretch( output, num_tones = 256, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_gaussian_contrast_stretch( \item{num_tones}{Number of tones in the output image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_gaussian_curvature.Rd b/man/wbt_gaussian_curvature.Rd index 550a6b0ea..cd5346e87 100644 --- a/man/wbt_gaussian_curvature.Rd +++ b/man/wbt_gaussian_curvature.Rd @@ -10,8 +10,8 @@ wbt_gaussian_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_gaussian_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_gaussian_filter.Rd b/man/wbt_gaussian_filter.Rd index d238007cd..1d44372d7 100644 --- a/man/wbt_gaussian_filter.Rd +++ b/man/wbt_gaussian_filter.Rd @@ -9,8 +9,8 @@ wbt_gaussian_filter( output, sigma = 0.75, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_gaussian_filter( \item{sigma}{Standard deviation distance in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_gaussian_scale_space.Rd b/man/wbt_gaussian_scale_space.Rd index 9c807d1cb..7ab744f35 100644 --- a/man/wbt_gaussian_scale_space.Rd +++ b/man/wbt_gaussian_scale_space.Rd @@ -16,8 +16,8 @@ wbt_gaussian_scale_space( lsp = "Slope", z_factor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_gaussian_scale_space( \item{z_factor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_generalize_classified_raster.Rd b/man/wbt_generalize_classified_raster.Rd index 871c4532e..a0a17410b 100644 --- a/man/wbt_generalize_classified_raster.Rd +++ b/man/wbt_generalize_classified_raster.Rd @@ -10,8 +10,8 @@ wbt_generalize_classified_raster( min_size = 4, method = "longest", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_generalize_classified_raster( \item{method}{Grouping method; one of 'longest' (default), 'largest', and 'nearest'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_generalize_with_similarity.Rd b/man/wbt_generalize_with_similarity.Rd index 59f5514bb..a9c05a1d8 100644 --- a/man/wbt_generalize_with_similarity.Rd +++ b/man/wbt_generalize_with_similarity.Rd @@ -10,8 +10,8 @@ wbt_generalize_with_similarity( output, min_size = 4, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_generalize_with_similarity( \item{min_size}{Minimum feature size, in grid cells.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_generating_function.Rd b/man/wbt_generating_function.Rd index e04aa7743..59b9ece36 100644 --- a/man/wbt_generating_function.Rd +++ b/man/wbt_generating_function.Rd @@ -10,8 +10,8 @@ wbt_generating_function( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_generating_function( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_geomorphons.Rd b/man/wbt_geomorphons.Rd index 9c36acdaa..c129b5066 100644 --- a/man/wbt_geomorphons.Rd +++ b/man/wbt_geomorphons.Rd @@ -14,8 +14,8 @@ wbt_geomorphons( forms = TRUE, residuals = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_geomorphons( \item{residuals}{Convert elevation to residuals of a linear model.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_greater_than.Rd b/man/wbt_greater_than.Rd index 6ee449a47..fa7be4f27 100644 --- a/man/wbt_greater_than.Rd +++ b/man/wbt_greater_than.Rd @@ -10,8 +10,8 @@ wbt_greater_than( output, incl_equals = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_greater_than( \item{incl_equals}{Perform a greater-than-or-equal-to operation.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_hack_stream_order.Rd b/man/wbt_hack_stream_order.Rd index 8fd48ea36..3d3ebd9ba 100644 --- a/man/wbt_hack_stream_order.Rd +++ b/man/wbt_hack_stream_order.Rd @@ -11,8 +11,8 @@ wbt_hack_stream_order( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_hack_stream_order( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_heat_map.Rd b/man/wbt_heat_map.Rd index ed62c957c..d954a11c6 100644 --- a/man/wbt_heat_map.Rd +++ b/man/wbt_heat_map.Rd @@ -13,8 +13,8 @@ wbt_heat_map( cell_size = "", base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_heat_map( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_height_above_ground.Rd b/man/wbt_height_above_ground.Rd index 2b13fc132..ed75fc8ff 100644 --- a/man/wbt_height_above_ground.Rd +++ b/man/wbt_height_above_ground.Rd @@ -8,8 +8,8 @@ wbt_height_above_ground( input, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_height_above_ground( \item{output}{Output lidar file (including extension).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_high_pass_bilateral_filter.Rd b/man/wbt_high_pass_bilateral_filter.Rd index 71e622106..6fc910adc 100644 --- a/man/wbt_high_pass_bilateral_filter.Rd +++ b/man/wbt_high_pass_bilateral_filter.Rd @@ -10,8 +10,8 @@ wbt_high_pass_bilateral_filter( sigma_dist = 0.75, sigma_int = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_high_pass_bilateral_filter( \item{sigma_int}{Standard deviation in intensity in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_high_pass_filter.Rd b/man/wbt_high_pass_filter.Rd index fdee94645..bfa6c9813 100644 --- a/man/wbt_high_pass_filter.Rd +++ b/man/wbt_high_pass_filter.Rd @@ -10,8 +10,8 @@ wbt_high_pass_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_high_pass_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_high_pass_median_filter.Rd b/man/wbt_high_pass_median_filter.Rd index 962aaf88d..0b013b8bc 100644 --- a/man/wbt_high_pass_median_filter.Rd +++ b/man/wbt_high_pass_median_filter.Rd @@ -11,8 +11,8 @@ wbt_high_pass_median_filter( filtery = 11, sig_digits = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_high_pass_median_filter( \item{sig_digits}{Number of significant digits.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_highest_position.Rd b/man/wbt_highest_position.Rd index b353efbe7..6a2e78ca6 100644 --- a/man/wbt_highest_position.Rd +++ b/man/wbt_highest_position.Rd @@ -8,8 +8,8 @@ wbt_highest_position( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_highest_position( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_hillshade.Rd b/man/wbt_hillshade.Rd index 8efd7d066..274d57e81 100644 --- a/man/wbt_hillshade.Rd +++ b/man/wbt_hillshade.Rd @@ -11,8 +11,8 @@ wbt_hillshade( altitude = 30, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_hillshade( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_hillslopes.Rd b/man/wbt_hillslopes.Rd index 10e9fc2b5..45df0ad67 100644 --- a/man/wbt_hillslopes.Rd +++ b/man/wbt_hillslopes.Rd @@ -10,8 +10,8 @@ wbt_hillslopes( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_hillslopes( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_histogram_equalization.Rd b/man/wbt_histogram_equalization.Rd index aea8da7d8..f4397af53 100644 --- a/man/wbt_histogram_equalization.Rd +++ b/man/wbt_histogram_equalization.Rd @@ -9,8 +9,8 @@ wbt_histogram_equalization( output, num_tones = 256, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_histogram_equalization( \item{num_tones}{Number of tones in the output image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_histogram_matching.Rd b/man/wbt_histogram_matching.Rd index 00aeeed02..fe33c827d 100644 --- a/man/wbt_histogram_matching.Rd +++ b/man/wbt_histogram_matching.Rd @@ -9,8 +9,8 @@ wbt_histogram_matching( histo_file, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_histogram_matching( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_histogram_matching_two_images.Rd b/man/wbt_histogram_matching_two_images.Rd index ad126f65d..8c72142c4 100644 --- a/man/wbt_histogram_matching_two_images.Rd +++ b/man/wbt_histogram_matching_two_images.Rd @@ -9,8 +9,8 @@ wbt_histogram_matching_two_images( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_histogram_matching_two_images( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_hole_proportion.Rd b/man/wbt_hole_proportion.Rd index c95bd1d89..feb924385 100644 --- a/man/wbt_hole_proportion.Rd +++ b/man/wbt_hole_proportion.Rd @@ -7,21 +7,21 @@ wbt_hole_proportion( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_horizon_angle.Rd b/man/wbt_horizon_angle.Rd index f5a440b9a..2912619c2 100644 --- a/man/wbt_horizon_angle.Rd +++ b/man/wbt_horizon_angle.Rd @@ -10,8 +10,8 @@ wbt_horizon_angle( azimuth = 0, max_dist = 100, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_horizon_angle( \item{max_dist}{Optional maximum search distance (unspecified if none; in xy units). Minimum value is 5 x cell size.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_horizontal_excess_curvature.Rd b/man/wbt_horizontal_excess_curvature.Rd index 10d0ce671..9ffe7d6af 100644 --- a/man/wbt_horizontal_excess_curvature.Rd +++ b/man/wbt_horizontal_excess_curvature.Rd @@ -10,8 +10,8 @@ wbt_horizontal_excess_curvature( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_horizontal_excess_curvature( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_horton_stream_order.Rd b/man/wbt_horton_stream_order.Rd index 70c632312..33b7af94a 100644 --- a/man/wbt_horton_stream_order.Rd +++ b/man/wbt_horton_stream_order.Rd @@ -11,8 +11,8 @@ wbt_horton_stream_order( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_horton_stream_order( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_hydrologic_connectivity.Rd b/man/wbt_hydrologic_connectivity.Rd index 388b4317c..577c5b633 100644 --- a/man/wbt_hydrologic_connectivity.Rd +++ b/man/wbt_hydrologic_connectivity.Rd @@ -11,8 +11,8 @@ wbt_hydrologic_connectivity( exponent = 1, threshold = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_hydrologic_connectivity( \item{threshold}{Optional convergence threshold parameter, in grid cells; default is infinity.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_hypsometric_analysis.Rd b/man/wbt_hypsometric_analysis.Rd index 8046f4641..2ed604e0c 100644 --- a/man/wbt_hypsometric_analysis.Rd +++ b/man/wbt_hypsometric_analysis.Rd @@ -9,8 +9,8 @@ wbt_hypsometric_analysis( output, watershed = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_hypsometric_analysis( \item{watershed}{Input watershed files (optional).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_hypsometrically_tinted_hillshade.Rd b/man/wbt_hypsometrically_tinted_hillshade.Rd index fa10224f6..5b11d48ce 100644 --- a/man/wbt_hypsometrically_tinted_hillshade.Rd +++ b/man/wbt_hypsometrically_tinted_hillshade.Rd @@ -16,8 +16,8 @@ wbt_hypsometrically_tinted_hillshade( zfactor = NULL, full_mode = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_hypsometrically_tinted_hillshade( \item{full_mode}{Optional flag indicating whether to use full 360-degrees of illumination sources.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_idw_interpolation.Rd b/man/wbt_idw_interpolation.Rd index 7a5c5ced4..9b29de910 100644 --- a/man/wbt_idw_interpolation.Rd +++ b/man/wbt_idw_interpolation.Rd @@ -15,8 +15,8 @@ wbt_idw_interpolation( cell_size = NULL, base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_idw_interpolation( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_ihs_to_rgb.Rd b/man/wbt_ihs_to_rgb.Rd index 04ae23436..e61fd8db8 100644 --- a/man/wbt_ihs_to_rgb.Rd +++ b/man/wbt_ihs_to_rgb.Rd @@ -13,8 +13,8 @@ wbt_ihs_to_rgb( blue = NULL, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_ihs_to_rgb( \item{output}{Output colour-composite file. Only used if individual bands are not specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_image_autocorrelation.Rd b/man/wbt_image_autocorrelation.Rd index abe01744f..c2f9eed24 100644 --- a/man/wbt_image_autocorrelation.Rd +++ b/man/wbt_image_autocorrelation.Rd @@ -9,8 +9,8 @@ wbt_image_autocorrelation( output, contiguity = "Rook", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_image_autocorrelation( \item{contiguity}{Contiguity type.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_image_correlation.Rd b/man/wbt_image_correlation.Rd index 23026bb79..66918b755 100644 --- a/man/wbt_image_correlation.Rd +++ b/man/wbt_image_correlation.Rd @@ -8,8 +8,8 @@ wbt_image_correlation( inputs, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_image_correlation( \item{output}{Output HTML file (default name will be based on input file if unspecified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_image_correlation_neighbourhood_analysis.Rd b/man/wbt_image_correlation_neighbourhood_analysis.Rd index b19853e3a..6f6c521bb 100644 --- a/man/wbt_image_correlation_neighbourhood_analysis.Rd +++ b/man/wbt_image_correlation_neighbourhood_analysis.Rd @@ -12,8 +12,8 @@ wbt_image_correlation_neighbourhood_analysis( filter = 11, stat = "pearson", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_image_correlation_neighbourhood_analysis( \item{stat}{Correlation type; one of 'pearson' (default) and 'spearman'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_image_regression.Rd b/man/wbt_image_regression.Rd index 22d3160ce..9f63eaa45 100644 --- a/man/wbt_image_regression.Rd +++ b/man/wbt_image_regression.Rd @@ -13,8 +13,8 @@ wbt_image_regression( scattergram = FALSE, num_samples = 1000, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_image_regression( \item{num_samples}{Number of samples used to create scattergram.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_image_segmentation.Rd b/man/wbt_image_segmentation.Rd index 7b8e2739b..b4d979a6b 100644 --- a/man/wbt_image_segmentation.Rd +++ b/man/wbt_image_segmentation.Rd @@ -11,8 +11,8 @@ wbt_image_segmentation( steps = 10, min_area = 4, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_image_segmentation( \item{min_area}{Minimum object area, in grid cells (1-8).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_image_slider.Rd b/man/wbt_image_slider.Rd index 9e5462dde..cba48ac2e 100644 --- a/man/wbt_image_slider.Rd +++ b/man/wbt_image_slider.Rd @@ -16,8 +16,8 @@ wbt_image_slider( label2 = "", height = 600, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_image_slider( \item{height}{Image height, in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_image_stack_profile.Rd b/man/wbt_image_stack_profile.Rd index 9e6bfa7ba..852e64c65 100644 --- a/man/wbt_image_stack_profile.Rd +++ b/man/wbt_image_stack_profile.Rd @@ -9,8 +9,8 @@ wbt_image_stack_profile( points, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_image_stack_profile( \item{output}{Output HTML file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_impoundment_size_index.Rd b/man/wbt_impoundment_size_index.Rd index 92d9fe809..665aaf340 100644 --- a/man/wbt_impoundment_size_index.Rd +++ b/man/wbt_impoundment_size_index.Rd @@ -13,8 +13,8 @@ wbt_impoundment_size_index( out_area = NULL, out_dam_height = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_impoundment_size_index( \item{out_dam_height}{Output dam height file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_in_place_add.Rd b/man/wbt_in_place_add.Rd index f4b2bcf48..54c1f6c22 100644 --- a/man/wbt_in_place_add.Rd +++ b/man/wbt_in_place_add.Rd @@ -8,8 +8,8 @@ wbt_in_place_add( input1, input2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_in_place_add( \item{input2}{Input raster file or constant value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_in_place_divide.Rd b/man/wbt_in_place_divide.Rd index cb4ae7672..06dfa822e 100644 --- a/man/wbt_in_place_divide.Rd +++ b/man/wbt_in_place_divide.Rd @@ -8,8 +8,8 @@ wbt_in_place_divide( input1, input2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_in_place_divide( \item{input2}{Input raster file or constant value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_in_place_multiply.Rd b/man/wbt_in_place_multiply.Rd index 25e60a140..03052e8f1 100644 --- a/man/wbt_in_place_multiply.Rd +++ b/man/wbt_in_place_multiply.Rd @@ -8,8 +8,8 @@ wbt_in_place_multiply( input1, input2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_in_place_multiply( \item{input2}{Input raster file or constant value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_in_place_subtract.Rd b/man/wbt_in_place_subtract.Rd index b433eac73..380fd0011 100644 --- a/man/wbt_in_place_subtract.Rd +++ b/man/wbt_in_place_subtract.Rd @@ -8,8 +8,8 @@ wbt_in_place_subtract( input1, input2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_in_place_subtract( \item{input2}{Input raster file or constant value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_increment.Rd b/man/wbt_increment.Rd index 2e251dae9..ef3d2d5b7 100644 --- a/man/wbt_increment.Rd +++ b/man/wbt_increment.Rd @@ -8,8 +8,8 @@ wbt_increment( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_increment( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_individual_tree_detection.Rd b/man/wbt_individual_tree_detection.Rd index 063ae97ab..2f32262ce 100644 --- a/man/wbt_individual_tree_detection.Rd +++ b/man/wbt_individual_tree_detection.Rd @@ -13,8 +13,8 @@ wbt_individual_tree_detection( max_height = "", only_use_veg = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_individual_tree_detection( \item{only_use_veg}{Only use veg. class points?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_insert_dams.Rd b/man/wbt_insert_dams.Rd index fca671cf3..c83638a07 100644 --- a/man/wbt_insert_dams.Rd +++ b/man/wbt_insert_dams.Rd @@ -10,8 +10,8 @@ wbt_insert_dams( output, damlength, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_insert_dams( \item{damlength}{Maximum length of the dam.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_install_wb_extension.Rd b/man/wbt_install_wb_extension.Rd index e689751fa..0c0a60ff8 100644 --- a/man/wbt_install_wb_extension.Rd +++ b/man/wbt_install_wb_extension.Rd @@ -7,21 +7,21 @@ wbt_install_wb_extension( install_extension = "General Toolset Extension", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{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'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_integer_division.Rd b/man/wbt_integer_division.Rd index 6dd7e2e6b..fe23b174a 100644 --- a/man/wbt_integer_division.Rd +++ b/man/wbt_integer_division.Rd @@ -9,8 +9,8 @@ wbt_integer_division( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_integer_division( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_integral_image.Rd b/man/wbt_integral_image.Rd index 75359e3c8..6dade2905 100644 --- a/man/wbt_integral_image.Rd +++ b/man/wbt_integral_image.Rd @@ -8,8 +8,8 @@ wbt_integral_image( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_integral_image( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_intersect.Rd b/man/wbt_intersect.Rd index 08eb9e71e..ed5218ca3 100644 --- a/man/wbt_intersect.Rd +++ b/man/wbt_intersect.Rd @@ -10,8 +10,8 @@ wbt_intersect( output, snap = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_intersect( \item{snap}{Snap tolerance.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_inverse_principal_component_analysis.Rd b/man/wbt_inverse_principal_component_analysis.Rd index b137bc230..f458fe81d 100644 --- a/man/wbt_inverse_principal_component_analysis.Rd +++ b/man/wbt_inverse_principal_component_analysis.Rd @@ -8,8 +8,8 @@ wbt_inverse_principal_component_analysis( inputs, report, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_inverse_principal_component_analysis( \item{report}{Name of the PCA report file (*.html).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_is_no_data.Rd b/man/wbt_is_no_data.Rd index 5d124c3af..814f57351 100644 --- a/man/wbt_is_no_data.Rd +++ b/man/wbt_is_no_data.Rd @@ -8,8 +8,8 @@ wbt_is_no_data( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_is_no_data( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_isobasins.Rd b/man/wbt_isobasins.Rd index 92e23df31..fbc5b9b6a 100644 --- a/man/wbt_isobasins.Rd +++ b/man/wbt_isobasins.Rd @@ -10,8 +10,8 @@ wbt_isobasins( size, connections = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_isobasins( \item{connections}{Output upstream-downstream flow connections among basins?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_jenson_snap_pour_points.Rd b/man/wbt_jenson_snap_pour_points.Rd index ffcdd5892..9b07f5e24 100644 --- a/man/wbt_jenson_snap_pour_points.Rd +++ b/man/wbt_jenson_snap_pour_points.Rd @@ -10,8 +10,8 @@ wbt_jenson_snap_pour_points( output, snap_dist, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_jenson_snap_pour_points( \item{snap_dist}{Maximum snap distance in map units.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_join_tables.Rd b/man/wbt_join_tables.Rd index 7e051fa79..a0895b07a 100644 --- a/man/wbt_join_tables.Rd +++ b/man/wbt_join_tables.Rd @@ -11,8 +11,8 @@ wbt_join_tables( fkey, import_field = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_join_tables( \item{import_field}{Imported field (all fields will be imported if not specified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_k_means_clustering.Rd b/man/wbt_k_means_clustering.Rd index ec7ebc6ed..8bcd7bd1a 100644 --- a/man/wbt_k_means_clustering.Rd +++ b/man/wbt_k_means_clustering.Rd @@ -14,8 +14,8 @@ wbt_k_means_clustering( initialize = "diagonal", min_class_size = 10, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_k_means_clustering( \item{min_class_size}{Minimum class size, in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_k_nearest_mean_filter.Rd b/man/wbt_k_nearest_mean_filter.Rd index 46e959707..df078f2ee 100644 --- a/man/wbt_k_nearest_mean_filter.Rd +++ b/man/wbt_k_nearest_mean_filter.Rd @@ -11,8 +11,8 @@ wbt_k_nearest_mean_filter( filtery = 11, k = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_k_nearest_mean_filter( \item{k}{k-value in pixels; this is the number of nearest-valued neighbours to use.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_kappa_index.Rd b/man/wbt_kappa_index.Rd index beb1c8b13..d7efa9192 100644 --- a/man/wbt_kappa_index.Rd +++ b/man/wbt_kappa_index.Rd @@ -9,8 +9,8 @@ wbt_kappa_index( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_kappa_index( \item{output}{Output HTML file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_knn_classification.Rd b/man/wbt_knn_classification.Rd index 59edf1ddc..319a0a3a5 100644 --- a/man/wbt_knn_classification.Rd +++ b/man/wbt_knn_classification.Rd @@ -14,8 +14,8 @@ wbt_knn_classification( clip = TRUE, test_proportion = 0.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_knn_classification( \item{test_proportion}{The proportion of the dataset to include in the test split; default is 0.2.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_knn_regression.Rd b/man/wbt_knn_regression.Rd index c002670f2..92543b256 100644 --- a/man/wbt_knn_regression.Rd +++ b/man/wbt_knn_regression.Rd @@ -14,8 +14,8 @@ wbt_knn_regression( weight = TRUE, test_proportion = 0.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_knn_regression( \item{test_proportion}{The proportion of the dataset to include in the test split; default is 0.2.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_ks_test_for_normality.Rd b/man/wbt_ks_test_for_normality.Rd index f2efb7e61..2c761af5f 100644 --- a/man/wbt_ks_test_for_normality.Rd +++ b/man/wbt_ks_test_for_normality.Rd @@ -9,8 +9,8 @@ wbt_ks_test_for_normality( output, num_samples = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_ks_test_for_normality( \item{num_samples}{Number of samples. Leave blank to use whole image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_laplacian_filter.Rd b/man/wbt_laplacian_filter.Rd index 560252068..b58bdd2d4 100644 --- a/man/wbt_laplacian_filter.Rd +++ b/man/wbt_laplacian_filter.Rd @@ -10,8 +10,8 @@ wbt_laplacian_filter( variant = "3x3(1)", clip = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_laplacian_filter( \item{clip}{Optional amount to clip the distribution tails by, in percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_laplacian_of_gaussian_filter.Rd b/man/wbt_laplacian_of_gaussian_filter.Rd index ff59e6bfd..adf59553e 100644 --- a/man/wbt_laplacian_of_gaussian_filter.Rd +++ b/man/wbt_laplacian_of_gaussian_filter.Rd @@ -9,8 +9,8 @@ wbt_laplacian_of_gaussian_filter( output, sigma = 0.75, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_laplacian_of_gaussian_filter( \item{sigma}{Standard deviation in pixels.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_las_to_ascii.Rd b/man/wbt_las_to_ascii.Rd index 2b45a916f..c5816b9eb 100644 --- a/man/wbt_las_to_ascii.Rd +++ b/man/wbt_las_to_ascii.Rd @@ -7,21 +7,21 @@ wbt_las_to_ascii( inputs, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{inputs}{Input LiDAR files.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_las_to_laz.Rd b/man/wbt_las_to_laz.Rd index 6ddcc37db..6ad403de7 100644 --- a/man/wbt_las_to_laz.Rd +++ b/man/wbt_las_to_laz.Rd @@ -8,8 +8,8 @@ wbt_las_to_laz( input, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_las_to_laz( \item{output}{Output LAZ file (including extension).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_las_to_multipoint_shapefile.Rd b/man/wbt_las_to_multipoint_shapefile.Rd index 268aa8818..1cd2ea947 100644 --- a/man/wbt_las_to_multipoint_shapefile.Rd +++ b/man/wbt_las_to_multipoint_shapefile.Rd @@ -7,21 +7,21 @@ wbt_las_to_multipoint_shapefile( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input LiDAR file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_las_to_shapefile.Rd b/man/wbt_las_to_shapefile.Rd index 6a507d45e..3ec096a9f 100644 --- a/man/wbt_las_to_shapefile.Rd +++ b/man/wbt_las_to_shapefile.Rd @@ -7,21 +7,21 @@ wbt_las_to_shapefile( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input LiDAR file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_las_to_zlidar.Rd b/man/wbt_las_to_zlidar.Rd index 12ee64f30..0102cc9b0 100644 --- a/man/wbt_las_to_zlidar.Rd +++ b/man/wbt_las_to_zlidar.Rd @@ -10,8 +10,8 @@ wbt_las_to_zlidar( compress = "brotli", level = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_las_to_zlidar( \item{level}{Compression level (1-9).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_launch_wb_runner.Rd b/man/wbt_launch_wb_runner.Rd index 26b5922e4..b3ad7b446 100644 --- a/man/wbt_launch_wb_runner.Rd +++ b/man/wbt_launch_wb_runner.Rd @@ -7,21 +7,21 @@ wbt_launch_wb_runner( clear_app_state = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{clear_app_state}{Clear the application state memory?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_layer_footprint.Rd b/man/wbt_layer_footprint.Rd index f056fa423..873d10f7f 100644 --- a/man/wbt_layer_footprint.Rd +++ b/man/wbt_layer_footprint.Rd @@ -8,8 +8,8 @@ wbt_layer_footprint( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_layer_footprint( \item{output}{Output vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_laz_to_las.Rd b/man/wbt_laz_to_las.Rd index cae7672c3..6b54f5701 100644 --- a/man/wbt_laz_to_las.Rd +++ b/man/wbt_laz_to_las.Rd @@ -8,8 +8,8 @@ wbt_laz_to_las( input, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_laz_to_las( \item{output}{Output LAS file (including extension).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lee_sigma_filter.Rd b/man/wbt_lee_sigma_filter.Rd index ddfe9de7a..807a08b7d 100644 --- a/man/wbt_lee_sigma_filter.Rd +++ b/man/wbt_lee_sigma_filter.Rd @@ -12,8 +12,8 @@ wbt_lee_sigma_filter( sigma = 10, m = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_lee_sigma_filter( \item{m}{M-threshold value the minimum allowable number of pixels within the intensity range.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_length_of_upstream_channels.Rd b/man/wbt_length_of_upstream_channels.Rd index 15f3c17d3..28304b556 100644 --- a/man/wbt_length_of_upstream_channels.Rd +++ b/man/wbt_length_of_upstream_channels.Rd @@ -11,8 +11,8 @@ wbt_length_of_upstream_channels( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_length_of_upstream_channels( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_less_than.Rd b/man/wbt_less_than.Rd index 10f6adbed..191cd4e52 100644 --- a/man/wbt_less_than.Rd +++ b/man/wbt_less_than.Rd @@ -10,8 +10,8 @@ wbt_less_than( output, incl_equals = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_less_than( \item{incl_equals}{Perform a less-than-or-equal-to operation.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_block_maximum.Rd b/man/wbt_lidar_block_maximum.Rd index eacc7a4d3..f45813cdc 100644 --- a/man/wbt_lidar_block_maximum.Rd +++ b/man/wbt_lidar_block_maximum.Rd @@ -9,8 +9,8 @@ wbt_lidar_block_maximum( output = NULL, resolution = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_lidar_block_maximum( \item{resolution}{Output raster's grid resolution.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_block_minimum.Rd b/man/wbt_lidar_block_minimum.Rd index e67ac7c22..9f794ee80 100644 --- a/man/wbt_lidar_block_minimum.Rd +++ b/man/wbt_lidar_block_minimum.Rd @@ -9,8 +9,8 @@ wbt_lidar_block_minimum( output = NULL, resolution = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_lidar_block_minimum( \item{resolution}{Output raster's grid resolution.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_classify_subset.Rd b/man/wbt_lidar_classify_subset.Rd index d30645762..90696197d 100644 --- a/man/wbt_lidar_classify_subset.Rd +++ b/man/wbt_lidar_classify_subset.Rd @@ -11,8 +11,8 @@ wbt_lidar_classify_subset( subset_class, nonsubset_class = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_lidar_classify_subset( \item{nonsubset_class}{Non-subset point class value (must be 0-18; see LAS specifications).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_colourize.Rd b/man/wbt_lidar_colourize.Rd index 23217ff09..fa07cb568 100644 --- a/man/wbt_lidar_colourize.Rd +++ b/man/wbt_lidar_colourize.Rd @@ -9,8 +9,8 @@ wbt_lidar_colourize( in_image, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_lidar_colourize( \item{output}{Output LiDAR file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_contour.Rd b/man/wbt_lidar_contour.Rd index 39183a8d3..d11eb759e 100644 --- a/man/wbt_lidar_contour.Rd +++ b/man/wbt_lidar_contour.Rd @@ -17,8 +17,8 @@ wbt_lidar_contour( maxz = NULL, max_triangle_edge_length = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -45,13 +45,13 @@ wbt_lidar_contour( \item{max_triangle_edge_length}{Optional maximum triangle edge length; triangles larger than this size will not be gridded.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_digital_surface_model.Rd b/man/wbt_lidar_digital_surface_model.Rd index 2fdb3c90a..ff64a6df3 100644 --- a/man/wbt_lidar_digital_surface_model.Rd +++ b/man/wbt_lidar_digital_surface_model.Rd @@ -13,8 +13,8 @@ wbt_lidar_digital_surface_model( maxz = NULL, max_triangle_edge_length = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_lidar_digital_surface_model( \item{max_triangle_edge_length}{Optional maximum triangle edge length; triangles larger than this size will not be gridded.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_eigenvalue_features.Rd b/man/wbt_lidar_eigenvalue_features.Rd index 97fe756eb..282c0f152 100644 --- a/man/wbt_lidar_eigenvalue_features.Rd +++ b/man/wbt_lidar_eigenvalue_features.Rd @@ -9,8 +9,8 @@ wbt_lidar_eigenvalue_features( num_neighbours = NULL, radius = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_lidar_eigenvalue_features( \item{radius}{Search distance used in neighbourhood search.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_elevation_slice.Rd b/man/wbt_lidar_elevation_slice.Rd index 641ef80e3..162c2278e 100644 --- a/man/wbt_lidar_elevation_slice.Rd +++ b/man/wbt_lidar_elevation_slice.Rd @@ -13,8 +13,8 @@ wbt_lidar_elevation_slice( inclassval = 2, outclassval = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_lidar_elevation_slice( \item{outclassval}{Optional parameter specifying the class value assigned to points within the slice.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_ground_point_filter.Rd b/man/wbt_lidar_ground_point_filter.Rd index e51b46c7e..dbb47593b 100644 --- a/man/wbt_lidar_ground_point_filter.Rd +++ b/man/wbt_lidar_ground_point_filter.Rd @@ -15,8 +15,8 @@ wbt_lidar_ground_point_filter( slope_norm = TRUE, height_above_ground = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_lidar_ground_point_filter( \item{height_above_ground}{Transform output to height above average ground elevation?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_hex_binning.Rd b/man/wbt_lidar_hex_binning.Rd index a1f0cf327..5b3514b49 100644 --- a/man/wbt_lidar_hex_binning.Rd +++ b/man/wbt_lidar_hex_binning.Rd @@ -10,8 +10,8 @@ wbt_lidar_hex_binning( width, orientation = "horizontal", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_lidar_hex_binning( \item{orientation}{Grid Orientation, 'horizontal' or 'vertical'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_hillshade.Rd b/man/wbt_lidar_hillshade.Rd index 0725ea877..f2f355d7f 100644 --- a/man/wbt_lidar_hillshade.Rd +++ b/man/wbt_lidar_hillshade.Rd @@ -11,8 +11,8 @@ wbt_lidar_hillshade( altitude = 30, radius = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_lidar_hillshade( \item{radius}{Search Radius.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_histogram.Rd b/man/wbt_lidar_histogram.Rd index 22896a538..903bab5a6 100644 --- a/man/wbt_lidar_histogram.Rd +++ b/man/wbt_lidar_histogram.Rd @@ -10,8 +10,8 @@ wbt_lidar_histogram( parameter = "elevation", clip = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_lidar_histogram( \item{clip}{Amount to clip distribution tails (in percent).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_idw_interpolation.Rd b/man/wbt_lidar_idw_interpolation.Rd index e09a792c2..b7a95aac2 100644 --- a/man/wbt_lidar_idw_interpolation.Rd +++ b/man/wbt_lidar_idw_interpolation.Rd @@ -16,8 +16,8 @@ wbt_lidar_idw_interpolation( minz = NULL, maxz = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_lidar_idw_interpolation( \item{maxz}{Optional maximum elevation for inclusion in interpolation.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_info.Rd b/man/wbt_lidar_info.Rd index 74a650132..c9b5f6c2b 100644 --- a/man/wbt_lidar_info.Rd +++ b/man/wbt_lidar_info.Rd @@ -11,8 +11,8 @@ wbt_lidar_info( vlr = TRUE, geokeys = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_lidar_info( \item{geokeys}{Flag indicating whether or not to print the geokeys.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_join.Rd b/man/wbt_lidar_join.Rd index bdc3f74db..130aead10 100644 --- a/man/wbt_lidar_join.Rd +++ b/man/wbt_lidar_join.Rd @@ -8,8 +8,8 @@ wbt_lidar_join( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_lidar_join( \item{output}{Output LiDAR file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_kappa_index.Rd b/man/wbt_lidar_kappa_index.Rd index f2071ab7a..86d91dba3 100644 --- a/man/wbt_lidar_kappa_index.Rd +++ b/man/wbt_lidar_kappa_index.Rd @@ -11,8 +11,8 @@ wbt_lidar_kappa_index( class_accuracy, resolution = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_lidar_kappa_index( \item{resolution}{Output raster's grid resolution.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_nearest_neighbour_gridding.Rd b/man/wbt_lidar_nearest_neighbour_gridding.Rd index aa397de0e..b02836f44 100644 --- a/man/wbt_lidar_nearest_neighbour_gridding.Rd +++ b/man/wbt_lidar_nearest_neighbour_gridding.Rd @@ -15,8 +15,8 @@ wbt_lidar_nearest_neighbour_gridding( minz = NULL, maxz = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_lidar_nearest_neighbour_gridding( \item{maxz}{Optional maximum elevation for inclusion in interpolation.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_point_density.Rd b/man/wbt_lidar_point_density.Rd index 21ecee06f..5b3a72ff1 100644 --- a/man/wbt_lidar_point_density.Rd +++ b/man/wbt_lidar_point_density.Rd @@ -14,8 +14,8 @@ wbt_lidar_point_density( minz = NULL, maxz = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_lidar_point_density( \item{maxz}{Optional maximum elevation for inclusion in interpolation.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_point_return_analysis.Rd b/man/wbt_lidar_point_return_analysis.Rd index f146c8f7e..8fdf1c3eb 100644 --- a/man/wbt_lidar_point_return_analysis.Rd +++ b/man/wbt_lidar_point_return_analysis.Rd @@ -8,8 +8,8 @@ wbt_lidar_point_return_analysis( input, output = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_lidar_point_return_analysis( \item{output}{Name of the output LiDAR points.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_point_stats.Rd b/man/wbt_lidar_point_stats.Rd index fb832406b..da97585d2 100644 --- a/man/wbt_lidar_point_stats.Rd +++ b/man/wbt_lidar_point_stats.Rd @@ -14,8 +14,8 @@ wbt_lidar_point_stats( intensity_range = FALSE, predom_class = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_lidar_point_stats( \item{predom_class}{Flag indicating whether or not to output the predominant classification raster.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_ransac_planes.Rd b/man/wbt_lidar_ransac_planes.Rd index f612abbff..87dd1844c 100644 --- a/man/wbt_lidar_ransac_planes.Rd +++ b/man/wbt_lidar_ransac_planes.Rd @@ -16,8 +16,8 @@ wbt_lidar_ransac_planes( classify = FALSE, last_returns = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_lidar_ransac_planes( \item{last_returns}{Only include last- and only-return points.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_rbf_interpolation.Rd b/man/wbt_lidar_rbf_interpolation.Rd index 385839832..2b3d4d9cd 100644 --- a/man/wbt_lidar_rbf_interpolation.Rd +++ b/man/wbt_lidar_rbf_interpolation.Rd @@ -18,8 +18,8 @@ wbt_lidar_rbf_interpolation( poly_order = "none", weight = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -48,13 +48,13 @@ wbt_lidar_rbf_interpolation( \item{weight}{Weight parameter used in basis function.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_remove_duplicates.Rd b/man/wbt_lidar_remove_duplicates.Rd index f5cb81e98..030f1f126 100644 --- a/man/wbt_lidar_remove_duplicates.Rd +++ b/man/wbt_lidar_remove_duplicates.Rd @@ -9,8 +9,8 @@ wbt_lidar_remove_duplicates( output, include_z = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_lidar_remove_duplicates( \item{include_z}{Include z-values in point comparison?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_remove_outliers.Rd b/man/wbt_lidar_remove_outliers.Rd index 44fa0b95d..5333ed247 100644 --- a/man/wbt_lidar_remove_outliers.Rd +++ b/man/wbt_lidar_remove_outliers.Rd @@ -12,8 +12,8 @@ wbt_lidar_remove_outliers( use_median = FALSE, classify = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_lidar_remove_outliers( \item{classify}{Classify points as ground (2) or off-ground (1).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_rooftop_analysis.Rd b/man/wbt_lidar_rooftop_analysis.Rd index c2179ed9f..6f1abbba6 100644 --- a/man/wbt_lidar_rooftop_analysis.Rd +++ b/man/wbt_lidar_rooftop_analysis.Rd @@ -18,8 +18,8 @@ wbt_lidar_rooftop_analysis( azimuth = 180, altitude = 30, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -48,13 +48,13 @@ wbt_lidar_rooftop_analysis( \item{altitude}{Illumination source altitude in degrees.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_segmentation.Rd b/man/wbt_lidar_segmentation.Rd index 3e8698f55..ea2d22ea3 100644 --- a/man/wbt_lidar_segmentation.Rd +++ b/man/wbt_lidar_segmentation.Rd @@ -18,8 +18,8 @@ wbt_lidar_segmentation( classes = FALSE, ground = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -48,13 +48,13 @@ wbt_lidar_segmentation( \item{ground}{Classify the largest segment as ground points?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_segmentation_based_filter.Rd b/man/wbt_lidar_segmentation_based_filter.Rd index acc617fe7..c0f2a6548 100644 --- a/man/wbt_lidar_segmentation_based_filter.Rd +++ b/man/wbt_lidar_segmentation_based_filter.Rd @@ -12,8 +12,8 @@ wbt_lidar_segmentation_based_filter( maxzdiff = 1, classify = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_lidar_segmentation_based_filter( \item{classify}{Classify points as ground (2) or off-ground (1).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_shift.Rd b/man/wbt_lidar_shift.Rd index f5e6ea12b..eba36888b 100644 --- a/man/wbt_lidar_shift.Rd +++ b/man/wbt_lidar_shift.Rd @@ -11,8 +11,8 @@ wbt_lidar_shift( y_shift = "", z_shift = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_lidar_shift( \item{z_shift}{z-shift value, blank for none.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_sibson_interpolation.Rd b/man/wbt_lidar_sibson_interpolation.Rd index e4b09c3c4..7cf6e38d9 100644 --- a/man/wbt_lidar_sibson_interpolation.Rd +++ b/man/wbt_lidar_sibson_interpolation.Rd @@ -14,8 +14,8 @@ wbt_lidar_sibson_interpolation( minz = NULL, maxz = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_lidar_sibson_interpolation( \item{maxz}{Optional maximum elevation for inclusion in interpolation.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_sort_by_time.Rd b/man/wbt_lidar_sort_by_time.Rd index fcbc7a0ca..5b238d6eb 100644 --- a/man/wbt_lidar_sort_by_time.Rd +++ b/man/wbt_lidar_sort_by_time.Rd @@ -8,8 +8,8 @@ wbt_lidar_sort_by_time( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_lidar_sort_by_time( \item{output}{Name of the output LiDAR points.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_thin.Rd b/man/wbt_lidar_thin.Rd index 3ee71c2b7..4c6d1116d 100644 --- a/man/wbt_lidar_thin.Rd +++ b/man/wbt_lidar_thin.Rd @@ -11,8 +11,8 @@ wbt_lidar_thin( method = "lowest", save_filtered = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_lidar_thin( \item{save_filtered}{Save filtered points to separate file?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_thin_high_density.Rd b/man/wbt_lidar_thin_high_density.Rd index 737bed784..724a40bd5 100644 --- a/man/wbt_lidar_thin_high_density.Rd +++ b/man/wbt_lidar_thin_high_density.Rd @@ -11,8 +11,8 @@ wbt_lidar_thin_high_density( resolution = 1, save_filtered = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_lidar_thin_high_density( \item{save_filtered}{Save filtered points to separate file?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_tile.Rd b/man/wbt_lidar_tile.Rd index 816dc2b18..57c429f05 100644 --- a/man/wbt_lidar_tile.Rd +++ b/man/wbt_lidar_tile.Rd @@ -12,8 +12,8 @@ wbt_lidar_tile( origin_y = 0, min_points = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_lidar_tile( \item{min_points}{Minimum number of points contained in a tile for it to be saved.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_tile_footprint.Rd b/man/wbt_lidar_tile_footprint.Rd index 192dbb04d..db0c57ae6 100644 --- a/man/wbt_lidar_tile_footprint.Rd +++ b/man/wbt_lidar_tile_footprint.Rd @@ -9,8 +9,8 @@ wbt_lidar_tile_footprint( output, hull = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_lidar_tile_footprint( \item{hull}{Identify the convex hull around points.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_tin_gridding.Rd b/man/wbt_lidar_tin_gridding.Rd index 56d1345f0..480695467 100644 --- a/man/wbt_lidar_tin_gridding.Rd +++ b/man/wbt_lidar_tin_gridding.Rd @@ -15,8 +15,8 @@ wbt_lidar_tin_gridding( maxz = NULL, max_triangle_edge_length = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_lidar_tin_gridding( \item{max_triangle_edge_length}{Optional maximum triangle edge length; triangles larger than this size will not be gridded.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lidar_tophat_transform.Rd b/man/wbt_lidar_tophat_transform.Rd index 845ab7d29..fd3546b93 100644 --- a/man/wbt_lidar_tophat_transform.Rd +++ b/man/wbt_lidar_tophat_transform.Rd @@ -9,8 +9,8 @@ wbt_lidar_tophat_transform( output, radius = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_lidar_tophat_transform( \item{radius}{Search Radius.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_line_detection_filter.Rd b/man/wbt_line_detection_filter.Rd index ada58cc60..0da74a882 100644 --- a/man/wbt_line_detection_filter.Rd +++ b/man/wbt_line_detection_filter.Rd @@ -11,8 +11,8 @@ wbt_line_detection_filter( absvals = FALSE, clip = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_line_detection_filter( \item{clip}{Optional amount to clip the distribution tails by, in percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_line_intersections.Rd b/man/wbt_line_intersections.Rd index 67d55316c..b6b23823a 100644 --- a/man/wbt_line_intersections.Rd +++ b/man/wbt_line_intersections.Rd @@ -9,8 +9,8 @@ wbt_line_intersections( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_line_intersections( \item{output}{Output vector point file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_line_thinning.Rd b/man/wbt_line_thinning.Rd index ca26fd67e..984750de0 100644 --- a/man/wbt_line_thinning.Rd +++ b/man/wbt_line_thinning.Rd @@ -8,8 +8,8 @@ wbt_line_thinning( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_line_thinning( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_linearity_index.Rd b/man/wbt_linearity_index.Rd index 51b166cd0..30fcb9662 100644 --- a/man/wbt_linearity_index.Rd +++ b/man/wbt_linearity_index.Rd @@ -7,21 +7,21 @@ wbt_linearity_index( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lines_to_polygons.Rd b/man/wbt_lines_to_polygons.Rd index 70e2e94fd..20e8ce240 100644 --- a/man/wbt_lines_to_polygons.Rd +++ b/man/wbt_lines_to_polygons.Rd @@ -8,8 +8,8 @@ wbt_lines_to_polygons( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_lines_to_polygons( \item{output}{Output vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_list_unique_values.Rd b/man/wbt_list_unique_values.Rd index 697f21a47..37b53d0ee 100644 --- a/man/wbt_list_unique_values.Rd +++ b/man/wbt_list_unique_values.Rd @@ -9,8 +9,8 @@ wbt_list_unique_values( field, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_list_unique_values( \item{output}{Output HTML file (default name will be based on input file if unspecified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_list_unique_values_raster.Rd b/man/wbt_list_unique_values_raster.Rd index 5440e38c0..1a6985c77 100644 --- a/man/wbt_list_unique_values_raster.Rd +++ b/man/wbt_list_unique_values_raster.Rd @@ -7,21 +7,21 @@ wbt_list_unique_values_raster( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_ln.Rd b/man/wbt_ln.Rd index f70fb0086..093806f01 100644 --- a/man/wbt_ln.Rd +++ b/man/wbt_ln.Rd @@ -8,8 +8,8 @@ wbt_ln( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_ln( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_local_hypsometric_analysis.Rd b/man/wbt_local_hypsometric_analysis.Rd index cf6e92711..2036ae191 100644 --- a/man/wbt_local_hypsometric_analysis.Rd +++ b/man/wbt_local_hypsometric_analysis.Rd @@ -13,8 +13,8 @@ wbt_local_hypsometric_analysis( num_steps = 10, step_nonlinearity = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_local_hypsometric_analysis( \item{step_nonlinearity}{Step nonlinearity factor (1.0-2.0 is typical).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_local_quadratic_regression.Rd b/man/wbt_local_quadratic_regression.Rd index 1eeb61a3e..7e662f236 100644 --- a/man/wbt_local_quadratic_regression.Rd +++ b/man/wbt_local_quadratic_regression.Rd @@ -9,8 +9,8 @@ wbt_local_quadratic_regression( output, filter = 3, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_local_quadratic_regression( \item{filter}{Edge length of the filter kernel.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_log10.Rd b/man/wbt_log10.Rd index 92c38eb8e..f2fdddbcb 100644 --- a/man/wbt_log10.Rd +++ b/man/wbt_log10.Rd @@ -8,8 +8,8 @@ wbt_log10( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_log10( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_log2.Rd b/man/wbt_log2.Rd index 6e2e97ea3..3e63f3830 100644 --- a/man/wbt_log2.Rd +++ b/man/wbt_log2.Rd @@ -8,8 +8,8 @@ wbt_log2( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_log2( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_logistic_regression.Rd b/man/wbt_logistic_regression.Rd index efbec1173..9786ad61e 100644 --- a/man/wbt_logistic_regression.Rd +++ b/man/wbt_logistic_regression.Rd @@ -12,8 +12,8 @@ wbt_logistic_regression( output = NULL, test_proportion = 0.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_logistic_regression( \item{test_proportion}{The proportion of the dataset to include in the test split; default is 0.2.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_long_profile.Rd b/man/wbt_long_profile.Rd index 2b74de894..fae322be7 100644 --- a/man/wbt_long_profile.Rd +++ b/man/wbt_long_profile.Rd @@ -11,8 +11,8 @@ wbt_long_profile( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_long_profile( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_long_profile_from_points.Rd b/man/wbt_long_profile_from_points.Rd index 8a66ba692..55d6601fa 100644 --- a/man/wbt_long_profile_from_points.Rd +++ b/man/wbt_long_profile_from_points.Rd @@ -11,8 +11,8 @@ wbt_long_profile_from_points( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_long_profile_from_points( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_longest_flowpath.Rd b/man/wbt_longest_flowpath.Rd index f033bd4b9..73d775bf9 100644 --- a/man/wbt_longest_flowpath.Rd +++ b/man/wbt_longest_flowpath.Rd @@ -9,8 +9,8 @@ wbt_longest_flowpath( basins, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_longest_flowpath( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_low_points_on_headwater_divides.Rd b/man/wbt_low_points_on_headwater_divides.Rd index 6808ebd78..e51b98228 100644 --- a/man/wbt_low_points_on_headwater_divides.Rd +++ b/man/wbt_low_points_on_headwater_divides.Rd @@ -9,8 +9,8 @@ wbt_low_points_on_headwater_divides( streams, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_low_points_on_headwater_divides( \item{output}{Name of the output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_lowest_position.Rd b/man/wbt_lowest_position.Rd index 003249382..c8eedb08c 100644 --- a/man/wbt_lowest_position.Rd +++ b/man/wbt_lowest_position.Rd @@ -8,8 +8,8 @@ wbt_lowest_position( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_lowest_position( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_majority_filter.Rd b/man/wbt_majority_filter.Rd index cc9be09d3..5bd5bdaa5 100644 --- a/man/wbt_majority_filter.Rd +++ b/man/wbt_majority_filter.Rd @@ -10,8 +10,8 @@ wbt_majority_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_majority_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_map_off_terrain_objects.Rd b/man/wbt_map_off_terrain_objects.Rd index ea8363536..a639a7f7c 100644 --- a/man/wbt_map_off_terrain_objects.Rd +++ b/man/wbt_map_off_terrain_objects.Rd @@ -10,8 +10,8 @@ wbt_map_off_terrain_objects( max_slope = 40, min_size = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_map_off_terrain_objects( \item{min_size}{Minimum feature size, in grid cells.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max.Rd b/man/wbt_max.Rd index 9cb6b45e8..33c810a50 100644 --- a/man/wbt_max.Rd +++ b/man/wbt_max.Rd @@ -9,8 +9,8 @@ wbt_max( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_max( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_absolute_overlay.Rd b/man/wbt_max_absolute_overlay.Rd index 183dcf9dc..20dd9c828 100644 --- a/man/wbt_max_absolute_overlay.Rd +++ b/man/wbt_max_absolute_overlay.Rd @@ -8,8 +8,8 @@ wbt_max_absolute_overlay( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_max_absolute_overlay( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_anisotropy_dev.Rd b/man/wbt_max_anisotropy_dev.Rd index 8df8228ef..c8ce61533 100644 --- a/man/wbt_max_anisotropy_dev.Rd +++ b/man/wbt_max_anisotropy_dev.Rd @@ -12,8 +12,8 @@ wbt_max_anisotropy_dev( min_scale = 3, step = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_max_anisotropy_dev( \item{step}{Step size as any positive non-zero integer.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_anisotropy_dev_signature.Rd b/man/wbt_max_anisotropy_dev_signature.Rd index 9980036f8..c810b2890 100644 --- a/man/wbt_max_anisotropy_dev_signature.Rd +++ b/man/wbt_max_anisotropy_dev_signature.Rd @@ -12,8 +12,8 @@ wbt_max_anisotropy_dev_signature( min_scale = 1, step = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_max_anisotropy_dev_signature( \item{step}{Step size as any positive non-zero integer.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_branch_length.Rd b/man/wbt_max_branch_length.Rd index 488b46200..54b89d812 100644 --- a/man/wbt_max_branch_length.Rd +++ b/man/wbt_max_branch_length.Rd @@ -9,8 +9,8 @@ wbt_max_branch_length( output, log = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_max_branch_length( \item{log}{Optional flag to request the output be log-transformed.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_difference_from_mean.Rd b/man/wbt_max_difference_from_mean.Rd index 048b7243d..8cc98f59b 100644 --- a/man/wbt_max_difference_from_mean.Rd +++ b/man/wbt_max_difference_from_mean.Rd @@ -12,8 +12,8 @@ wbt_max_difference_from_mean( max_scale, step = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_max_difference_from_mean( \item{step}{Step size as any positive non-zero integer.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_downslope_elev_change.Rd b/man/wbt_max_downslope_elev_change.Rd index 388e61920..a015c0341 100644 --- a/man/wbt_max_downslope_elev_change.Rd +++ b/man/wbt_max_downslope_elev_change.Rd @@ -8,8 +8,8 @@ wbt_max_downslope_elev_change( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_max_downslope_elev_change( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_elev_dev_signature.Rd b/man/wbt_max_elev_dev_signature.Rd index 5dbcd6f43..3da723790 100644 --- a/man/wbt_max_elev_dev_signature.Rd +++ b/man/wbt_max_elev_dev_signature.Rd @@ -12,8 +12,8 @@ wbt_max_elev_dev_signature( max_scale, step = 10, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_max_elev_dev_signature( \item{step}{Step size as any positive non-zero integer.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_elevation_deviation.Rd b/man/wbt_max_elevation_deviation.Rd index 1cf7c88ff..892c5fe2a 100644 --- a/man/wbt_max_elevation_deviation.Rd +++ b/man/wbt_max_elevation_deviation.Rd @@ -12,8 +12,8 @@ wbt_max_elevation_deviation( max_scale, step = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_max_elevation_deviation( \item{step}{Step size as any positive non-zero integer.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_overlay.Rd b/man/wbt_max_overlay.Rd index ede972baa..171af41ed 100644 --- a/man/wbt_max_overlay.Rd +++ b/man/wbt_max_overlay.Rd @@ -8,8 +8,8 @@ wbt_max_overlay( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_max_overlay( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_upslope_elev_change.Rd b/man/wbt_max_upslope_elev_change.Rd index 7f0376108..f0cf1d1dc 100644 --- a/man/wbt_max_upslope_elev_change.Rd +++ b/man/wbt_max_upslope_elev_change.Rd @@ -8,8 +8,8 @@ wbt_max_upslope_elev_change( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_max_upslope_elev_change( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_upslope_flowpath_length.Rd b/man/wbt_max_upslope_flowpath_length.Rd index b5ca363c6..b585b088b 100644 --- a/man/wbt_max_upslope_flowpath_length.Rd +++ b/man/wbt_max_upslope_flowpath_length.Rd @@ -8,8 +8,8 @@ wbt_max_upslope_flowpath_length( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_max_upslope_flowpath_length( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_max_upslope_value.Rd b/man/wbt_max_upslope_value.Rd index 443f241ac..b8f927a39 100644 --- a/man/wbt_max_upslope_value.Rd +++ b/man/wbt_max_upslope_value.Rd @@ -9,8 +9,8 @@ wbt_max_upslope_value( values, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_max_upslope_value( \item{output}{Name of the output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_maximal_curvature.Rd b/man/wbt_maximal_curvature.Rd index 1910f04b0..d33d171c4 100644 --- a/man/wbt_maximal_curvature.Rd +++ b/man/wbt_maximal_curvature.Rd @@ -10,8 +10,8 @@ wbt_maximal_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_maximal_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_maximum_filter.Rd b/man/wbt_maximum_filter.Rd index cfb04ccf8..b4c726b14 100644 --- a/man/wbt_maximum_filter.Rd +++ b/man/wbt_maximum_filter.Rd @@ -10,8 +10,8 @@ wbt_maximum_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_maximum_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_md_inf_flow_accumulation.Rd b/man/wbt_md_inf_flow_accumulation.Rd index b3eb1eeac..43f5292a9 100644 --- a/man/wbt_md_inf_flow_accumulation.Rd +++ b/man/wbt_md_inf_flow_accumulation.Rd @@ -13,8 +13,8 @@ wbt_md_inf_flow_accumulation( log = FALSE, clip = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_md_inf_flow_accumulation( \item{clip}{Optional flag to request clipping the display max by 1 percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_mean_curvature.Rd b/man/wbt_mean_curvature.Rd index 337fd66b6..33378942e 100644 --- a/man/wbt_mean_curvature.Rd +++ b/man/wbt_mean_curvature.Rd @@ -10,8 +10,8 @@ wbt_mean_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_mean_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_mean_filter.Rd b/man/wbt_mean_filter.Rd index 818d2ebfe..e7574aec5 100644 --- a/man/wbt_mean_filter.Rd +++ b/man/wbt_mean_filter.Rd @@ -10,8 +10,8 @@ wbt_mean_filter( filterx = 3, filtery = 3, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_mean_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_median_filter.Rd b/man/wbt_median_filter.Rd index 0dff45a83..d98e37e31 100644 --- a/man/wbt_median_filter.Rd +++ b/man/wbt_median_filter.Rd @@ -11,8 +11,8 @@ wbt_median_filter( filtery = 11, sig_digits = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_median_filter( \item{sig_digits}{Number of significant digits.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_medoid.Rd b/man/wbt_medoid.Rd index 8bcc571fd..46527d42a 100644 --- a/man/wbt_medoid.Rd +++ b/man/wbt_medoid.Rd @@ -8,8 +8,8 @@ wbt_medoid( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_medoid( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_merge_line_segments.Rd b/man/wbt_merge_line_segments.Rd index e89ef308b..ee060f4ef 100644 --- a/man/wbt_merge_line_segments.Rd +++ b/man/wbt_merge_line_segments.Rd @@ -9,8 +9,8 @@ wbt_merge_line_segments( output, snap = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_merge_line_segments( \item{snap}{Snap tolerance.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_merge_table_with_csv.Rd b/man/wbt_merge_table_with_csv.Rd index 515677789..25bda3f0a 100644 --- a/man/wbt_merge_table_with_csv.Rd +++ b/man/wbt_merge_table_with_csv.Rd @@ -11,8 +11,8 @@ wbt_merge_table_with_csv( fkey, import_field = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_merge_table_with_csv( \item{import_field}{Imported field (all fields will be imported if not specified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_merge_vectors.Rd b/man/wbt_merge_vectors.Rd index 2cbab82a1..bfcea5ecc 100644 --- a/man/wbt_merge_vectors.Rd +++ b/man/wbt_merge_vectors.Rd @@ -8,8 +8,8 @@ wbt_merge_vectors( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_merge_vectors( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_min.Rd b/man/wbt_min.Rd index 804bee7a2..3b7bd3928 100644 --- a/man/wbt_min.Rd +++ b/man/wbt_min.Rd @@ -9,8 +9,8 @@ wbt_min( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_min( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_min_absolute_overlay.Rd b/man/wbt_min_absolute_overlay.Rd index 8061a85b6..cfef4ba7a 100644 --- a/man/wbt_min_absolute_overlay.Rd +++ b/man/wbt_min_absolute_overlay.Rd @@ -8,8 +8,8 @@ wbt_min_absolute_overlay( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_min_absolute_overlay( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_min_dist_classification.Rd b/man/wbt_min_dist_classification.Rd index 5931c03c9..21dd23d18 100644 --- a/man/wbt_min_dist_classification.Rd +++ b/man/wbt_min_dist_classification.Rd @@ -11,8 +11,8 @@ wbt_min_dist_classification( output, threshold = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_min_dist_classification( \item{threshold}{Distance threshold, in z-scores; blank for none.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_min_downslope_elev_change.Rd b/man/wbt_min_downslope_elev_change.Rd index 643f5cca8..741c04f3d 100644 --- a/man/wbt_min_downslope_elev_change.Rd +++ b/man/wbt_min_downslope_elev_change.Rd @@ -8,8 +8,8 @@ wbt_min_downslope_elev_change( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_min_downslope_elev_change( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_min_max_contrast_stretch.Rd b/man/wbt_min_max_contrast_stretch.Rd index c8affe780..ba7e5b3ad 100644 --- a/man/wbt_min_max_contrast_stretch.Rd +++ b/man/wbt_min_max_contrast_stretch.Rd @@ -11,8 +11,8 @@ wbt_min_max_contrast_stretch( max_val, num_tones = 256, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_min_max_contrast_stretch( \item{num_tones}{Number of tones in the output image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_min_overlay.Rd b/man/wbt_min_overlay.Rd index 8475ddaf6..ab447d559 100644 --- a/man/wbt_min_overlay.Rd +++ b/man/wbt_min_overlay.Rd @@ -8,8 +8,8 @@ wbt_min_overlay( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_min_overlay( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_minimal_curvature.Rd b/man/wbt_minimal_curvature.Rd index 59ba1a948..c5e760b31 100644 --- a/man/wbt_minimal_curvature.Rd +++ b/man/wbt_minimal_curvature.Rd @@ -10,8 +10,8 @@ wbt_minimal_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_minimal_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_minimum_bounding_box.Rd b/man/wbt_minimum_bounding_box.Rd index 2c2217e38..ff79640c9 100644 --- a/man/wbt_minimum_bounding_box.Rd +++ b/man/wbt_minimum_bounding_box.Rd @@ -10,8 +10,8 @@ wbt_minimum_bounding_box( criterion = "area", features = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_minimum_bounding_box( \item{features}{Find the minimum bounding rectangles around each individual vector feature.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_minimum_bounding_circle.Rd b/man/wbt_minimum_bounding_circle.Rd index 3a18a4c43..032e66943 100644 --- a/man/wbt_minimum_bounding_circle.Rd +++ b/man/wbt_minimum_bounding_circle.Rd @@ -9,8 +9,8 @@ wbt_minimum_bounding_circle( output, features = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_minimum_bounding_circle( \item{features}{Find the minimum bounding circle around each individual vector feature.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_minimum_bounding_envelope.Rd b/man/wbt_minimum_bounding_envelope.Rd index c86d28885..5ad4c4cd2 100644 --- a/man/wbt_minimum_bounding_envelope.Rd +++ b/man/wbt_minimum_bounding_envelope.Rd @@ -9,8 +9,8 @@ wbt_minimum_bounding_envelope( output, features = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_minimum_bounding_envelope( \item{features}{Find the minimum bounding envelop around each individual vector feature.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_minimum_convex_hull.Rd b/man/wbt_minimum_convex_hull.Rd index 5366d2208..d258af440 100644 --- a/man/wbt_minimum_convex_hull.Rd +++ b/man/wbt_minimum_convex_hull.Rd @@ -9,8 +9,8 @@ wbt_minimum_convex_hull( output, features = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_minimum_convex_hull( \item{features}{Find the hulls around each vector feature.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_minimum_filter.Rd b/man/wbt_minimum_filter.Rd index de30f3e6f..b7709dfab 100644 --- a/man/wbt_minimum_filter.Rd +++ b/man/wbt_minimum_filter.Rd @@ -10,8 +10,8 @@ wbt_minimum_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_minimum_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_modified_k_means_clustering.Rd b/man/wbt_modified_k_means_clustering.Rd index 9b9a3544b..1e80588b3 100644 --- a/man/wbt_modified_k_means_clustering.Rd +++ b/man/wbt_modified_k_means_clustering.Rd @@ -13,8 +13,8 @@ wbt_modified_k_means_clustering( max_iterations = 10, class_change = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_modified_k_means_clustering( \item{class_change}{Minimum percent of cells changed between iterations before completion.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_modify_lidar.Rd b/man/wbt_modify_lidar.Rd index 83b0fa474..b780e5c8a 100644 --- a/man/wbt_modify_lidar.Rd +++ b/man/wbt_modify_lidar.Rd @@ -9,8 +9,8 @@ wbt_modify_lidar( output = NULL, statement = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_modify_lidar( \item{statement}{Modify statement e.g. x += 5000.0.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_modify_no_data_value.Rd b/man/wbt_modify_no_data_value.Rd index b0d044fbc..e73c281b4 100644 --- a/man/wbt_modify_no_data_value.Rd +++ b/man/wbt_modify_no_data_value.Rd @@ -8,8 +8,8 @@ wbt_modify_no_data_value( input, new_value = "-32768.0", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_modify_no_data_value( \item{new_value}{New NoData value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_modulo.Rd b/man/wbt_modulo.Rd index 6907dce4a..ea99fcfb6 100644 --- a/man/wbt_modulo.Rd +++ b/man/wbt_modulo.Rd @@ -9,8 +9,8 @@ wbt_modulo( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_modulo( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_mosaic.Rd b/man/wbt_mosaic.Rd index b83aa2b5e..5527e40d4 100644 --- a/man/wbt_mosaic.Rd +++ b/man/wbt_mosaic.Rd @@ -9,8 +9,8 @@ wbt_mosaic( inputs = NULL, method = "nn", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_mosaic( \item{method}{Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_mosaic_with_feathering.Rd b/man/wbt_mosaic_with_feathering.Rd index 28c756420..7665b6a26 100644 --- a/man/wbt_mosaic_with_feathering.Rd +++ b/man/wbt_mosaic_with_feathering.Rd @@ -11,8 +11,8 @@ wbt_mosaic_with_feathering( method = "cc", weight = 4, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_mosaic_with_feathering( \item{weight}{.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multi_part_to_single_part.Rd b/man/wbt_multi_part_to_single_part.Rd index 8a22400df..3c880ab99 100644 --- a/man/wbt_multi_part_to_single_part.Rd +++ b/man/wbt_multi_part_to_single_part.Rd @@ -9,8 +9,8 @@ wbt_multi_part_to_single_part( output, exclude_holes = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_multi_part_to_single_part( \item{exclude_holes}{Exclude hole parts from the feature splitting? (holes will continue to belong to their features in output.).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multidirectional_hillshade.Rd b/man/wbt_multidirectional_hillshade.Rd index 4ddb65f53..7347f0cb0 100644 --- a/man/wbt_multidirectional_hillshade.Rd +++ b/man/wbt_multidirectional_hillshade.Rd @@ -11,8 +11,8 @@ wbt_multidirectional_hillshade( zfactor = NULL, full_mode = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_multidirectional_hillshade( \item{full_mode}{Optional flag indicating whether to use full 360-degrees of illumination sources.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiply.Rd b/man/wbt_multiply.Rd index 2d239a9d3..259dcdffc 100644 --- a/man/wbt_multiply.Rd +++ b/man/wbt_multiply.Rd @@ -9,8 +9,8 @@ wbt_multiply( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_multiply( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiply_overlay.Rd b/man/wbt_multiply_overlay.Rd index 884537d09..2f9bfa035 100644 --- a/man/wbt_multiply_overlay.Rd +++ b/man/wbt_multiply_overlay.Rd @@ -8,8 +8,8 @@ wbt_multiply_overlay( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_multiply_overlay( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiscale_curvatures.Rd b/man/wbt_multiscale_curvatures.Rd index 0a6f16c1a..ffafcb74b 100644 --- a/man/wbt_multiscale_curvatures.Rd +++ b/man/wbt_multiscale_curvatures.Rd @@ -16,8 +16,8 @@ wbt_multiscale_curvatures( log = TRUE, standardize = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_multiscale_curvatures( \item{standardize}{Should each scale be standardized to z-scores?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiscale_elevation_percentile.Rd b/man/wbt_multiscale_elevation_percentile.Rd index 6d992cf39..ea2600607 100644 --- a/man/wbt_multiscale_elevation_percentile.Rd +++ b/man/wbt_multiscale_elevation_percentile.Rd @@ -14,8 +14,8 @@ wbt_multiscale_elevation_percentile( num_steps = 10, step_nonlinearity = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_multiscale_elevation_percentile( \item{step_nonlinearity}{Step nonlinearity factor (1.0-2.0 is typical).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiscale_roughness.Rd b/man/wbt_multiscale_roughness.Rd index c0a0aa7ce..0d8988884 100644 --- a/man/wbt_multiscale_roughness.Rd +++ b/man/wbt_multiscale_roughness.Rd @@ -12,8 +12,8 @@ wbt_multiscale_roughness( min_scale = 1, step = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_multiscale_roughness( \item{step}{Step size as any positive non-zero integer.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiscale_roughness_signature.Rd b/man/wbt_multiscale_roughness_signature.Rd index a35dc7838..6f41bc39c 100644 --- a/man/wbt_multiscale_roughness_signature.Rd +++ b/man/wbt_multiscale_roughness_signature.Rd @@ -12,8 +12,8 @@ wbt_multiscale_roughness_signature( min_scale = 1, step = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_multiscale_roughness_signature( \item{step}{Step size as any positive non-zero integer.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiscale_std_dev_normals.Rd b/man/wbt_multiscale_std_dev_normals.Rd index 5be12de04..84d49e533 100644 --- a/man/wbt_multiscale_std_dev_normals.Rd +++ b/man/wbt_multiscale_std_dev_normals.Rd @@ -13,8 +13,8 @@ wbt_multiscale_std_dev_normals( num_steps = 10, step_nonlinearity = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_multiscale_std_dev_normals( \item{step_nonlinearity}{Step nonlinearity factor (1.0-2.0 is typical).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiscale_std_dev_normals_signature.Rd b/man/wbt_multiscale_std_dev_normals_signature.Rd index a3e9cfb6c..10c0aadda 100644 --- a/man/wbt_multiscale_std_dev_normals_signature.Rd +++ b/man/wbt_multiscale_std_dev_normals_signature.Rd @@ -13,8 +13,8 @@ wbt_multiscale_std_dev_normals_signature( num_steps = 10, step_nonlinearity = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_multiscale_std_dev_normals_signature( \item{step_nonlinearity}{Step nonlinearity factor (1.0-2.0 is typical).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_multiscale_topographic_position_image.Rd b/man/wbt_multiscale_topographic_position_image.Rd index 8ed697247..97584f8b3 100644 --- a/man/wbt_multiscale_topographic_position_image.Rd +++ b/man/wbt_multiscale_topographic_position_image.Rd @@ -12,8 +12,8 @@ wbt_multiscale_topographic_position_image( hillshade = NULL, lightness = 1.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_multiscale_topographic_position_image( \item{lightness}{Image lightness value (default is 1.2).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_narrowness_index.Rd b/man/wbt_narrowness_index.Rd index 7cbaabc58..4d78557e4 100644 --- a/man/wbt_narrowness_index.Rd +++ b/man/wbt_narrowness_index.Rd @@ -8,8 +8,8 @@ wbt_narrowness_index( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_narrowness_index( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_natural_neighbour_interpolation.Rd b/man/wbt_natural_neighbour_interpolation.Rd index 891cb8ed0..dcc74c352 100644 --- a/man/wbt_natural_neighbour_interpolation.Rd +++ b/man/wbt_natural_neighbour_interpolation.Rd @@ -13,8 +13,8 @@ wbt_natural_neighbour_interpolation( base = NULL, clip = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_natural_neighbour_interpolation( \item{clip}{Clip the data to the convex hull of the points?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_nearest_neighbour_gridding.Rd b/man/wbt_nearest_neighbour_gridding.Rd index d5504ac10..7bc6e2dd0 100644 --- a/man/wbt_nearest_neighbour_gridding.Rd +++ b/man/wbt_nearest_neighbour_gridding.Rd @@ -13,8 +13,8 @@ wbt_nearest_neighbour_gridding( base = NULL, max_dist = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_nearest_neighbour_gridding( \item{max_dist}{Maximum search distance (optional).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_negate.Rd b/man/wbt_negate.Rd index 54527646a..d1babda7a 100644 --- a/man/wbt_negate.Rd +++ b/man/wbt_negate.Rd @@ -8,8 +8,8 @@ wbt_negate( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_negate( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_new_raster_from_base.Rd b/man/wbt_new_raster_from_base.Rd index e36e51012..7f3f82542 100644 --- a/man/wbt_new_raster_from_base.Rd +++ b/man/wbt_new_raster_from_base.Rd @@ -11,8 +11,8 @@ wbt_new_raster_from_base( data_type = "float", cell_size = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_new_raster_from_base( \item{cell_size}{Optionally specified cell size of output raster. Not used when base raster is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_normal_vectors.Rd b/man/wbt_normal_vectors.Rd index 31e9e66ab..353f7f673 100644 --- a/man/wbt_normal_vectors.Rd +++ b/man/wbt_normal_vectors.Rd @@ -9,8 +9,8 @@ wbt_normal_vectors( output, radius = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_normal_vectors( \item{radius}{Search Radius.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_normalize_lidar.Rd b/man/wbt_normalize_lidar.Rd index 51cf4510c..2fc1d557c 100644 --- a/man/wbt_normalize_lidar.Rd +++ b/man/wbt_normalize_lidar.Rd @@ -9,8 +9,8 @@ wbt_normalize_lidar( output, dtm, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_normalize_lidar( \item{dtm}{Name of the input digital terrain model (DTM) raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_normalized_difference_index.Rd b/man/wbt_normalized_difference_index.Rd index 96ddae094..7b3a5c62f 100644 --- a/man/wbt_normalized_difference_index.Rd +++ b/man/wbt_normalized_difference_index.Rd @@ -11,8 +11,8 @@ wbt_normalized_difference_index( clip = 0, correction = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_normalized_difference_index( \item{correction}{Optional adjustment value (e.g. 1, or 0.16 for the optimal soil adjusted vegetation index, OSAVI).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_not.Rd b/man/wbt_not.Rd index ee2c4af45..7a68beefc 100644 --- a/man/wbt_not.Rd +++ b/man/wbt_not.Rd @@ -9,8 +9,8 @@ wbt_not( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_not( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_not_equal_to.Rd b/man/wbt_not_equal_to.Rd index bc9578613..25eaa5905 100644 --- a/man/wbt_not_equal_to.Rd +++ b/man/wbt_not_equal_to.Rd @@ -9,8 +9,8 @@ wbt_not_equal_to( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_not_equal_to( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_num_downslope_neighbours.Rd b/man/wbt_num_downslope_neighbours.Rd index 1049f0bd7..60ca32286 100644 --- a/man/wbt_num_downslope_neighbours.Rd +++ b/man/wbt_num_downslope_neighbours.Rd @@ -8,8 +8,8 @@ wbt_num_downslope_neighbours( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_num_downslope_neighbours( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_num_inflowing_neighbours.Rd b/man/wbt_num_inflowing_neighbours.Rd index 48513976b..658e954e6 100644 --- a/man/wbt_num_inflowing_neighbours.Rd +++ b/man/wbt_num_inflowing_neighbours.Rd @@ -8,8 +8,8 @@ wbt_num_inflowing_neighbours( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_num_inflowing_neighbours( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_num_upslope_neighbours.Rd b/man/wbt_num_upslope_neighbours.Rd index e17394215..26a2396d9 100644 --- a/man/wbt_num_upslope_neighbours.Rd +++ b/man/wbt_num_upslope_neighbours.Rd @@ -8,8 +8,8 @@ wbt_num_upslope_neighbours( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_num_upslope_neighbours( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_olympic_filter.Rd b/man/wbt_olympic_filter.Rd index 2a400786a..4d73c4a4e 100644 --- a/man/wbt_olympic_filter.Rd +++ b/man/wbt_olympic_filter.Rd @@ -10,8 +10,8 @@ wbt_olympic_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_olympic_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_opening.Rd b/man/wbt_opening.Rd index 4dd07f4ed..bddf4ffc6 100644 --- a/man/wbt_opening.Rd +++ b/man/wbt_opening.Rd @@ -10,8 +10,8 @@ wbt_opening( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_opening( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_openness.Rd b/man/wbt_openness.Rd index 73b22a57c..d2d0d1dfe 100644 --- a/man/wbt_openness.Rd +++ b/man/wbt_openness.Rd @@ -10,8 +10,8 @@ wbt_openness( neg_output, dist = 20, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_openness( \item{dist}{Search distance, in grid cells.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_or.Rd b/man/wbt_or.Rd index 0c5785674..94f0baff8 100644 --- a/man/wbt_or.Rd +++ b/man/wbt_or.Rd @@ -9,8 +9,8 @@ wbt_or( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_or( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_paired_sample_t_test.Rd b/man/wbt_paired_sample_t_test.Rd index cc2cdb442..86634cc5b 100644 --- a/man/wbt_paired_sample_t_test.Rd +++ b/man/wbt_paired_sample_t_test.Rd @@ -10,8 +10,8 @@ wbt_paired_sample_t_test( output, num_samples = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_paired_sample_t_test( \item{num_samples}{Number of samples. Leave blank to use whole image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_panchromatic_sharpening.Rd b/man/wbt_panchromatic_sharpening.Rd index a81d3811a..261a76d44 100644 --- a/man/wbt_panchromatic_sharpening.Rd +++ b/man/wbt_panchromatic_sharpening.Rd @@ -13,8 +13,8 @@ wbt_panchromatic_sharpening( composite = NULL, method = "brovey", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_panchromatic_sharpening( \item{method}{Options include 'brovey' (default) and 'ihs'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_parallelepiped_classification.Rd b/man/wbt_parallelepiped_classification.Rd index 216dddb25..9315e38c5 100644 --- a/man/wbt_parallelepiped_classification.Rd +++ b/man/wbt_parallelepiped_classification.Rd @@ -10,8 +10,8 @@ wbt_parallelepiped_classification( field, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_parallelepiped_classification( \item{output}{Name of the output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_patch_orientation.Rd b/man/wbt_patch_orientation.Rd index b3df81e4c..d5b412948 100644 --- a/man/wbt_patch_orientation.Rd +++ b/man/wbt_patch_orientation.Rd @@ -7,21 +7,21 @@ wbt_patch_orientation( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_pennock_landform_class.Rd b/man/wbt_pennock_landform_class.Rd index 7e1255c46..a629a51ec 100644 --- a/man/wbt_pennock_landform_class.Rd +++ b/man/wbt_pennock_landform_class.Rd @@ -12,8 +12,8 @@ wbt_pennock_landform_class( plan = 0, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_pennock_landform_class( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_percent_elev_range.Rd b/man/wbt_percent_elev_range.Rd index f2f97160c..fbe9b3f8f 100644 --- a/man/wbt_percent_elev_range.Rd +++ b/man/wbt_percent_elev_range.Rd @@ -10,8 +10,8 @@ wbt_percent_elev_range( filterx = 3, filtery = 3, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_percent_elev_range( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_percent_equal_to.Rd b/man/wbt_percent_equal_to.Rd index 4333ed89a..4aaf4a1df 100644 --- a/man/wbt_percent_equal_to.Rd +++ b/man/wbt_percent_equal_to.Rd @@ -9,8 +9,8 @@ wbt_percent_equal_to( comparison, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_percent_equal_to( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_percent_greater_than.Rd b/man/wbt_percent_greater_than.Rd index 7624990d6..0abbcc6c5 100644 --- a/man/wbt_percent_greater_than.Rd +++ b/man/wbt_percent_greater_than.Rd @@ -9,8 +9,8 @@ wbt_percent_greater_than( comparison, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_percent_greater_than( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_percent_less_than.Rd b/man/wbt_percent_less_than.Rd index 4c81b00b1..3efaaedc7 100644 --- a/man/wbt_percent_less_than.Rd +++ b/man/wbt_percent_less_than.Rd @@ -9,8 +9,8 @@ wbt_percent_less_than( comparison, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_percent_less_than( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_percentage_contrast_stretch.Rd b/man/wbt_percentage_contrast_stretch.Rd index f189549c7..498110869 100644 --- a/man/wbt_percentage_contrast_stretch.Rd +++ b/man/wbt_percentage_contrast_stretch.Rd @@ -11,8 +11,8 @@ wbt_percentage_contrast_stretch( tail = "both", num_tones = 256, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_percentage_contrast_stretch( \item{num_tones}{Number of tones in the output image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_percentile_filter.Rd b/man/wbt_percentile_filter.Rd index 90eaf1383..226171f7d 100644 --- a/man/wbt_percentile_filter.Rd +++ b/man/wbt_percentile_filter.Rd @@ -11,8 +11,8 @@ wbt_percentile_filter( filtery = 11, sig_digits = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_percentile_filter( \item{sig_digits}{Number of significant digits.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_perimeter_area_ratio.Rd b/man/wbt_perimeter_area_ratio.Rd index 0da3c6c75..abdd852d5 100644 --- a/man/wbt_perimeter_area_ratio.Rd +++ b/man/wbt_perimeter_area_ratio.Rd @@ -7,21 +7,21 @@ wbt_perimeter_area_ratio( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_phi_coefficient.Rd b/man/wbt_phi_coefficient.Rd index 1bcb13ed6..8ceb6e485 100644 --- a/man/wbt_phi_coefficient.Rd +++ b/man/wbt_phi_coefficient.Rd @@ -9,8 +9,8 @@ wbt_phi_coefficient( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_phi_coefficient( \item{output}{Name of the output HTML file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_pick_from_list.Rd b/man/wbt_pick_from_list.Rd index 95513b881..7aa020290 100644 --- a/man/wbt_pick_from_list.Rd +++ b/man/wbt_pick_from_list.Rd @@ -9,8 +9,8 @@ wbt_pick_from_list( pos_input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_pick_from_list( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_piecewise_contrast_stretch.Rd b/man/wbt_piecewise_contrast_stretch.Rd index eae125611..b2a21bc0e 100644 --- a/man/wbt_piecewise_contrast_stretch.Rd +++ b/man/wbt_piecewise_contrast_stretch.Rd @@ -10,8 +10,8 @@ wbt_piecewise_contrast_stretch( FUN = "", greytones = 1024, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_piecewise_contrast_stretch( \item{greytones}{Number of greytones in the output image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_plan_curvature.Rd b/man/wbt_plan_curvature.Rd index e51352bc0..149bed25b 100644 --- a/man/wbt_plan_curvature.Rd +++ b/man/wbt_plan_curvature.Rd @@ -10,8 +10,8 @@ wbt_plan_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_plan_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_polygon_area.Rd b/man/wbt_polygon_area.Rd index 49361baf6..4e5a34b4e 100644 --- a/man/wbt_polygon_area.Rd +++ b/man/wbt_polygon_area.Rd @@ -7,21 +7,21 @@ wbt_polygon_area( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_polygon_long_axis.Rd b/man/wbt_polygon_long_axis.Rd index fe11838fa..a5023d815 100644 --- a/man/wbt_polygon_long_axis.Rd +++ b/man/wbt_polygon_long_axis.Rd @@ -8,8 +8,8 @@ wbt_polygon_long_axis( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_polygon_long_axis( \item{output}{Output vector polyline file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_polygon_perimeter.Rd b/man/wbt_polygon_perimeter.Rd index 0c2f60447..c2751a491 100644 --- a/man/wbt_polygon_perimeter.Rd +++ b/man/wbt_polygon_perimeter.Rd @@ -7,21 +7,21 @@ wbt_polygon_perimeter( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_polygon_short_axis.Rd b/man/wbt_polygon_short_axis.Rd index 986c2ea41..5908505aa 100644 --- a/man/wbt_polygon_short_axis.Rd +++ b/man/wbt_polygon_short_axis.Rd @@ -8,8 +8,8 @@ wbt_polygon_short_axis( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_polygon_short_axis( \item{output}{Output vector polyline file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_polygonize.Rd b/man/wbt_polygonize.Rd index f75517cd6..c99953c58 100644 --- a/man/wbt_polygonize.Rd +++ b/man/wbt_polygonize.Rd @@ -8,8 +8,8 @@ wbt_polygonize( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_polygonize( \item{output}{Output vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_polygons_to_lines.Rd b/man/wbt_polygons_to_lines.Rd index 3a1df280b..6336cd90d 100644 --- a/man/wbt_polygons_to_lines.Rd +++ b/man/wbt_polygons_to_lines.Rd @@ -8,8 +8,8 @@ wbt_polygons_to_lines( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_polygons_to_lines( \item{output}{Output vector lines file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_power.Rd b/man/wbt_power.Rd index f180074a3..8dc102ebb 100644 --- a/man/wbt_power.Rd +++ b/man/wbt_power.Rd @@ -9,8 +9,8 @@ wbt_power( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_power( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_prewitt_filter.Rd b/man/wbt_prewitt_filter.Rd index 998f88822..8ae9b42de 100644 --- a/man/wbt_prewitt_filter.Rd +++ b/man/wbt_prewitt_filter.Rd @@ -9,8 +9,8 @@ wbt_prewitt_filter( output, clip = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_prewitt_filter( \item{clip}{Optional amount to clip the distribution tails by, in percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_principal_component_analysis.Rd b/man/wbt_principal_component_analysis.Rd index b6c72e374..0f13eb714 100644 --- a/man/wbt_principal_component_analysis.Rd +++ b/man/wbt_principal_component_analysis.Rd @@ -10,8 +10,8 @@ wbt_principal_component_analysis( num_comp = NULL, standardized = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_principal_component_analysis( \item{standardized}{Perform standardized PCA?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_print_geo_tiff_tags.Rd b/man/wbt_print_geo_tiff_tags.Rd index 559ed20ff..684893731 100644 --- a/man/wbt_print_geo_tiff_tags.Rd +++ b/man/wbt_print_geo_tiff_tags.Rd @@ -7,21 +7,21 @@ wbt_print_geo_tiff_tags( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input GeoTIFF file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_profile.Rd b/man/wbt_profile.Rd index efb92d649..bd19606d0 100644 --- a/man/wbt_profile.Rd +++ b/man/wbt_profile.Rd @@ -9,8 +9,8 @@ wbt_profile( surface, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_profile( \item{output}{Output HTML file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_profile_curvature.Rd b/man/wbt_profile_curvature.Rd index 2d358791e..82d3ab52d 100644 --- a/man/wbt_profile_curvature.Rd +++ b/man/wbt_profile_curvature.Rd @@ -10,8 +10,8 @@ wbt_profile_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_profile_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_qin_flow_accumulation.Rd b/man/wbt_qin_flow_accumulation.Rd index d15e4ee10..48c32aa94 100644 --- a/man/wbt_qin_flow_accumulation.Rd +++ b/man/wbt_qin_flow_accumulation.Rd @@ -14,8 +14,8 @@ wbt_qin_flow_accumulation( log = FALSE, clip = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_qin_flow_accumulation( \item{clip}{Optional flag to request clipping the display max by 1 percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_quantiles.Rd b/man/wbt_quantiles.Rd index de83879a3..10d98a4cf 100644 --- a/man/wbt_quantiles.Rd +++ b/man/wbt_quantiles.Rd @@ -9,8 +9,8 @@ wbt_quantiles( output, num_quantiles = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_quantiles( \item{num_quantiles}{Number of quantiles.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_quinn_flow_accumulation.Rd b/man/wbt_quinn_flow_accumulation.Rd index 5334c2e21..c8b8eb719 100644 --- a/man/wbt_quinn_flow_accumulation.Rd +++ b/man/wbt_quinn_flow_accumulation.Rd @@ -13,8 +13,8 @@ wbt_quinn_flow_accumulation( log = FALSE, clip = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_quinn_flow_accumulation( \item{clip}{Optional flag to request clipping the display max by 1 percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_radial_basis_function_interpolation.Rd b/man/wbt_radial_basis_function_interpolation.Rd index 0ff18b60e..40c9ee1ad 100644 --- a/man/wbt_radial_basis_function_interpolation.Rd +++ b/man/wbt_radial_basis_function_interpolation.Rd @@ -17,8 +17,8 @@ wbt_radial_basis_function_interpolation( cell_size = NULL, base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -45,13 +45,13 @@ wbt_radial_basis_function_interpolation( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_radius_of_gyration.Rd b/man/wbt_radius_of_gyration.Rd index 4d352678c..dce68ec8c 100644 --- a/man/wbt_radius_of_gyration.Rd +++ b/man/wbt_radius_of_gyration.Rd @@ -9,8 +9,8 @@ wbt_radius_of_gyration( output, text_output = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_radius_of_gyration( \item{text_output}{Optional text output.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raise_walls.Rd b/man/wbt_raise_walls.Rd index e74100c0e..74e85cc6f 100644 --- a/man/wbt_raise_walls.Rd +++ b/man/wbt_raise_walls.Rd @@ -11,8 +11,8 @@ wbt_raise_walls( breach = NULL, height = 100, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_raise_walls( \item{height}{Wall height.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_random_field.Rd b/man/wbt_random_field.Rd index 4ca033020..66993d38e 100644 --- a/man/wbt_random_field.Rd +++ b/man/wbt_random_field.Rd @@ -8,8 +8,8 @@ wbt_random_field( base, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_random_field( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_random_forest_classification.Rd b/man/wbt_random_forest_classification.Rd index 026f02a4d..be3b7a37f 100644 --- a/man/wbt_random_forest_classification.Rd +++ b/man/wbt_random_forest_classification.Rd @@ -15,8 +15,8 @@ wbt_random_forest_classification( min_samples_split = 2, test_proportion = 0.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_random_forest_classification( \item{test_proportion}{The proportion of the dataset to include in the test split; default is 0.2.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_random_forest_regression.Rd b/man/wbt_random_forest_regression.Rd index e46c07cef..fbc039c4f 100644 --- a/man/wbt_random_forest_regression.Rd +++ b/man/wbt_random_forest_regression.Rd @@ -14,8 +14,8 @@ wbt_random_forest_regression( min_samples_split = 2, test_proportion = 0.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_random_forest_regression( \item{test_proportion}{The proportion of the dataset to include in the test split; default is 0.2.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_random_sample.Rd b/man/wbt_random_sample.Rd index f627e594b..96dd72c6f 100644 --- a/man/wbt_random_sample.Rd +++ b/man/wbt_random_sample.Rd @@ -9,8 +9,8 @@ wbt_random_sample( output, num_samples = 1000, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_random_sample( \item{num_samples}{Number of samples.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_range_filter.Rd b/man/wbt_range_filter.Rd index 24c92bf27..316e190f4 100644 --- a/man/wbt_range_filter.Rd +++ b/man/wbt_range_filter.Rd @@ -10,8 +10,8 @@ wbt_range_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_range_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_area.Rd b/man/wbt_raster_area.Rd index fea7588a8..02609e5ff 100644 --- a/man/wbt_raster_area.Rd +++ b/man/wbt_raster_area.Rd @@ -11,8 +11,8 @@ wbt_raster_area( units = "grid cells", zero_back = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_raster_area( \item{zero_back}{Flag indicating whether zero values should be treated as a background.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_calculator.Rd b/man/wbt_raster_calculator.Rd index 687d9e697..8e842649a 100644 --- a/man/wbt_raster_calculator.Rd +++ b/man/wbt_raster_calculator.Rd @@ -8,8 +8,8 @@ wbt_raster_calculator( output, statement = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_raster_calculator( \item{statement}{Statement e.g. cos("raster1") * 35.0 + "raster2". This statement must be a valid Rust statement.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_cell_assignment.Rd b/man/wbt_raster_cell_assignment.Rd index 18e92499c..4d86a5e84 100644 --- a/man/wbt_raster_cell_assignment.Rd +++ b/man/wbt_raster_cell_assignment.Rd @@ -9,8 +9,8 @@ wbt_raster_cell_assignment( output, assign = "column", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_raster_cell_assignment( \item{assign}{Which variable would you like to assign to grid cells? Options include 'column', 'row', 'x', and 'y'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_histogram.Rd b/man/wbt_raster_histogram.Rd index dbecf7fb3..f31c8515b 100644 --- a/man/wbt_raster_histogram.Rd +++ b/man/wbt_raster_histogram.Rd @@ -8,8 +8,8 @@ wbt_raster_histogram( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_raster_histogram( \item{output}{Output HTML file (default name will be based on input file if unspecified).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_perimeter.Rd b/man/wbt_raster_perimeter.Rd index 0ab3ea6a4..990f8eea3 100644 --- a/man/wbt_raster_perimeter.Rd +++ b/man/wbt_raster_perimeter.Rd @@ -11,8 +11,8 @@ wbt_raster_perimeter( units = "grid cells", zero_back = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_raster_perimeter( \item{zero_back}{Flag indicating whether zero values should be treated as a background.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_streams_to_vector.Rd b/man/wbt_raster_streams_to_vector.Rd index 737db0565..8235f7338 100644 --- a/man/wbt_raster_streams_to_vector.Rd +++ b/man/wbt_raster_streams_to_vector.Rd @@ -10,8 +10,8 @@ wbt_raster_streams_to_vector( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_raster_streams_to_vector( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_summary_stats.Rd b/man/wbt_raster_summary_stats.Rd index d56172c0e..e4e194ced 100644 --- a/man/wbt_raster_summary_stats.Rd +++ b/man/wbt_raster_summary_stats.Rd @@ -7,21 +7,21 @@ wbt_raster_summary_stats( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_to_vector_lines.Rd b/man/wbt_raster_to_vector_lines.Rd index 1a5547a4c..6c53d99d9 100644 --- a/man/wbt_raster_to_vector_lines.Rd +++ b/man/wbt_raster_to_vector_lines.Rd @@ -8,8 +8,8 @@ wbt_raster_to_vector_lines( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_raster_to_vector_lines( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_to_vector_points.Rd b/man/wbt_raster_to_vector_points.Rd index 29a8871b5..06cdac009 100644 --- a/man/wbt_raster_to_vector_points.Rd +++ b/man/wbt_raster_to_vector_points.Rd @@ -8,8 +8,8 @@ wbt_raster_to_vector_points( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_raster_to_vector_points( \item{output}{Output vector points file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_raster_to_vector_polygons.Rd b/man/wbt_raster_to_vector_polygons.Rd index 674d6c94f..57c43e499 100644 --- a/man/wbt_raster_to_vector_polygons.Rd +++ b/man/wbt_raster_to_vector_polygons.Rd @@ -8,8 +8,8 @@ wbt_raster_to_vector_polygons( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_raster_to_vector_polygons( \item{output}{Output vector polygons file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_rasterize_streams.Rd b/man/wbt_rasterize_streams.Rd index f14b933f5..c4770597d 100644 --- a/man/wbt_rasterize_streams.Rd +++ b/man/wbt_rasterize_streams.Rd @@ -11,8 +11,8 @@ wbt_rasterize_streams( nodata = TRUE, feature_id = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_rasterize_streams( \item{feature_id}{Use feature number as output value?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_reciprocal.Rd b/man/wbt_reciprocal.Rd index 1e519e3bb..2465ae07d 100644 --- a/man/wbt_reciprocal.Rd +++ b/man/wbt_reciprocal.Rd @@ -8,8 +8,8 @@ wbt_reciprocal( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_reciprocal( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_reclass.Rd b/man/wbt_reclass.Rd index 1dea85b47..9cfe4f46d 100644 --- a/man/wbt_reclass.Rd +++ b/man/wbt_reclass.Rd @@ -10,8 +10,8 @@ wbt_reclass( reclass_vals, assign_mode = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_reclass( \item{assign_mode}{Optional Boolean flag indicating whether to operate in assign mode, reclass_vals values are interpreted as new value; old value pairs.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_reclass_equal_interval.Rd b/man/wbt_reclass_equal_interval.Rd index 7e7bfb963..ed569223d 100644 --- a/man/wbt_reclass_equal_interval.Rd +++ b/man/wbt_reclass_equal_interval.Rd @@ -11,8 +11,8 @@ wbt_reclass_equal_interval( start_val = NULL, end_val = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_reclass_equal_interval( \item{end_val}{Optional ending value (default is input maximum value).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_reclass_from_file.Rd b/man/wbt_reclass_from_file.Rd index 114b9bc68..8bb0eb669 100644 --- a/man/wbt_reclass_from_file.Rd +++ b/man/wbt_reclass_from_file.Rd @@ -9,8 +9,8 @@ wbt_reclass_from_file( reclass_file, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_reclass_from_file( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_reconcile_multiple_headers.Rd b/man/wbt_reconcile_multiple_headers.Rd index 448489aba..422ce3dc2 100644 --- a/man/wbt_reconcile_multiple_headers.Rd +++ b/man/wbt_reconcile_multiple_headers.Rd @@ -14,8 +14,8 @@ wbt_reconcile_multiple_headers( max_yield = NULL, mean_tonnage = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_reconcile_multiple_headers( \item{mean_tonnage}{Use this optional parameter to force the output to have a certain overall average tonnage.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_recover_flightline_info.Rd b/man/wbt_recover_flightline_info.Rd index 9ed5db3e8..39525446a 100644 --- a/man/wbt_recover_flightline_info.Rd +++ b/man/wbt_recover_flightline_info.Rd @@ -12,8 +12,8 @@ wbt_recover_flightline_info( user_data = FALSE, rgb = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_recover_flightline_info( \item{rgb}{Add flightline information to the RGB colour data.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_recreate_pass_lines.Rd b/man/wbt_recreate_pass_lines.Rd index ac30bb4ab..b02725a4c 100644 --- a/man/wbt_recreate_pass_lines.Rd +++ b/man/wbt_recreate_pass_lines.Rd @@ -12,8 +12,8 @@ wbt_recreate_pass_lines( max_change_in_heading = 25, ignore_zeros = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_recreate_pass_lines( \item{ignore_zeros}{Ignore zero-valued yield points?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_reinitialize_attribute_table.Rd b/man/wbt_reinitialize_attribute_table.Rd index 64b8a07a5..4c4244438 100644 --- a/man/wbt_reinitialize_attribute_table.Rd +++ b/man/wbt_reinitialize_attribute_table.Rd @@ -7,21 +7,21 @@ wbt_reinitialize_attribute_table( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_related_circumscribing_circle.Rd b/man/wbt_related_circumscribing_circle.Rd index f7d5c8fa4..d56d23fec 100644 --- a/man/wbt_related_circumscribing_circle.Rd +++ b/man/wbt_related_circumscribing_circle.Rd @@ -7,21 +7,21 @@ wbt_related_circumscribing_circle( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_relative_aspect.Rd b/man/wbt_relative_aspect.Rd index fd319d6e6..fb38b46d4 100644 --- a/man/wbt_relative_aspect.Rd +++ b/man/wbt_relative_aspect.Rd @@ -10,8 +10,8 @@ wbt_relative_aspect( azimuth = 0, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_relative_aspect( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_relative_topographic_position.Rd b/man/wbt_relative_topographic_position.Rd index 7c0183ad5..3fafe5add 100644 --- a/man/wbt_relative_topographic_position.Rd +++ b/man/wbt_relative_topographic_position.Rd @@ -10,8 +10,8 @@ wbt_relative_topographic_position( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_relative_topographic_position( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_remove_field_edge_points.Rd b/man/wbt_remove_field_edge_points.Rd index 56b0c2cd7..bc74f83a9 100644 --- a/man/wbt_remove_field_edge_points.Rd +++ b/man/wbt_remove_field_edge_points.Rd @@ -11,8 +11,8 @@ wbt_remove_field_edge_points( max_change_in_heading = 25, flag_edges = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_remove_field_edge_points( \item{flag_edges}{Don't remove edge points, just flag them in the attribute table?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_remove_off_terrain_objects.Rd b/man/wbt_remove_off_terrain_objects.Rd index e78cb52df..d0e150e12 100644 --- a/man/wbt_remove_off_terrain_objects.Rd +++ b/man/wbt_remove_off_terrain_objects.Rd @@ -10,8 +10,8 @@ wbt_remove_off_terrain_objects( filter = 11, slope = 15, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_remove_off_terrain_objects( \item{slope}{Slope threshold value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_remove_polygon_holes.Rd b/man/wbt_remove_polygon_holes.Rd index 7111175ef..827bdda96 100644 --- a/man/wbt_remove_polygon_holes.Rd +++ b/man/wbt_remove_polygon_holes.Rd @@ -8,8 +8,8 @@ wbt_remove_polygon_holes( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_remove_polygon_holes( \item{output}{Output vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_remove_raster_polygon_holes.Rd b/man/wbt_remove_raster_polygon_holes.Rd index 5f9d8d748..416b0544e 100644 --- a/man/wbt_remove_raster_polygon_holes.Rd +++ b/man/wbt_remove_raster_polygon_holes.Rd @@ -10,8 +10,8 @@ wbt_remove_raster_polygon_holes( threshold = 3, use_diagonals = TRUE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_remove_raster_polygon_holes( \item{use_diagonals}{Use diagonal neighbours during clumping operation.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_remove_short_streams.Rd b/man/wbt_remove_short_streams.Rd index f9b114cd8..8409a66b8 100644 --- a/man/wbt_remove_short_streams.Rd +++ b/man/wbt_remove_short_streams.Rd @@ -11,8 +11,8 @@ wbt_remove_short_streams( min_length, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_remove_short_streams( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_remove_spurs.Rd b/man/wbt_remove_spurs.Rd index 85c2866a1..031e601a8 100644 --- a/man/wbt_remove_spurs.Rd +++ b/man/wbt_remove_spurs.Rd @@ -9,8 +9,8 @@ wbt_remove_spurs( output, iterations = 10, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_remove_spurs( \item{iterations}{Maximum number of iterations.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_repair_stream_vector_topology.Rd b/man/wbt_repair_stream_vector_topology.Rd index 73022565f..329736dfa 100644 --- a/man/wbt_repair_stream_vector_topology.Rd +++ b/man/wbt_repair_stream_vector_topology.Rd @@ -9,8 +9,8 @@ wbt_repair_stream_vector_topology( output, dist = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_repair_stream_vector_topology( \item{dist}{Snap distance, in xy units (metres).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_resample.Rd b/man/wbt_resample.Rd index 2963e3514..3a9c6f583 100644 --- a/man/wbt_resample.Rd +++ b/man/wbt_resample.Rd @@ -11,8 +11,8 @@ wbt_resample( base = NULL, method = "cc", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_resample( \item{method}{Resampling method; options include 'nn' (nearest neighbour), 'bilinear', and 'cc' (cubic convolution).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_rescale_value_range.Rd b/man/wbt_rescale_value_range.Rd index 5e9c5057a..986283d33 100644 --- a/man/wbt_rescale_value_range.Rd +++ b/man/wbt_rescale_value_range.Rd @@ -12,8 +12,8 @@ wbt_rescale_value_range( clip_min = NULL, clip_max = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_rescale_value_range( \item{clip_max}{Optional upper tail clip value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_rgb_to_ihs.Rd b/man/wbt_rgb_to_ihs.Rd index 8284e7d63..6cc0b3a1a 100644 --- a/man/wbt_rgb_to_ihs.Rd +++ b/man/wbt_rgb_to_ihs.Rd @@ -13,8 +13,8 @@ wbt_rgb_to_ihs( blue = NULL, composite = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_rgb_to_ihs( \item{composite}{Input colour-composite image file. Only used if individual bands are not specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_rho8_flow_accumulation.Rd b/man/wbt_rho8_flow_accumulation.Rd index dd7c4c9a7..8ef309a6c 100644 --- a/man/wbt_rho8_flow_accumulation.Rd +++ b/man/wbt_rho8_flow_accumulation.Rd @@ -13,8 +13,8 @@ wbt_rho8_flow_accumulation( pntr = FALSE, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_rho8_flow_accumulation( \item{esri_pntr}{Does the input Rho8 pointer use the ESRI style scheme?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_rho8_pointer.Rd b/man/wbt_rho8_pointer.Rd index 18ff4eff4..0a5f88c6c 100644 --- a/man/wbt_rho8_pointer.Rd +++ b/man/wbt_rho8_pointer.Rd @@ -9,8 +9,8 @@ wbt_rho8_pointer( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_rho8_pointer( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_ring_curvature.Rd b/man/wbt_ring_curvature.Rd index 2c0e80733..95f8215a8 100644 --- a/man/wbt_ring_curvature.Rd +++ b/man/wbt_ring_curvature.Rd @@ -10,8 +10,8 @@ wbt_ring_curvature( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_ring_curvature( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_river_centerlines.Rd b/man/wbt_river_centerlines.Rd index 6a41822f1..1edb17d52 100644 --- a/man/wbt_river_centerlines.Rd +++ b/man/wbt_river_centerlines.Rd @@ -10,8 +10,8 @@ wbt_river_centerlines( min_length = 3, radius = 4, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_river_centerlines( \item{radius}{Search radius for joining distant endnodes, in grid cells.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_roberts_cross_filter.Rd b/man/wbt_roberts_cross_filter.Rd index 16b829e81..79ac96a5f 100644 --- a/man/wbt_roberts_cross_filter.Rd +++ b/man/wbt_roberts_cross_filter.Rd @@ -9,8 +9,8 @@ wbt_roberts_cross_filter( output, clip = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_roberts_cross_filter( \item{clip}{Optional amount to clip the distribution tails by, in percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_root_mean_square_error.Rd b/man/wbt_root_mean_square_error.Rd index 181a66eac..a203ed8be 100644 --- a/man/wbt_root_mean_square_error.Rd +++ b/man/wbt_root_mean_square_error.Rd @@ -8,8 +8,8 @@ wbt_root_mean_square_error( input, base, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_root_mean_square_error( \item{base}{Input base raster file used for comparison.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_rotor.Rd b/man/wbt_rotor.Rd index d6ec3d643..16154c3bf 100644 --- a/man/wbt_rotor.Rd +++ b/man/wbt_rotor.Rd @@ -10,8 +10,8 @@ wbt_rotor( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_rotor( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_round.Rd b/man/wbt_round.Rd index 04728ede0..6f78a1339 100644 --- a/man/wbt_round.Rd +++ b/man/wbt_round.Rd @@ -8,8 +8,8 @@ wbt_round( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_round( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_ruggedness_index.Rd b/man/wbt_ruggedness_index.Rd index d771373a6..eafcfc181 100644 --- a/man/wbt_ruggedness_index.Rd +++ b/man/wbt_ruggedness_index.Rd @@ -8,8 +8,8 @@ wbt_ruggedness_index( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_ruggedness_index( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_scharr_filter.Rd b/man/wbt_scharr_filter.Rd index e3e9843a9..2cc6d3b15 100644 --- a/man/wbt_scharr_filter.Rd +++ b/man/wbt_scharr_filter.Rd @@ -9,8 +9,8 @@ wbt_scharr_filter( output, clip = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_scharr_filter( \item{clip}{Optional amount to clip the distribution tails by, in percent.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sediment_transport_index.Rd b/man/wbt_sediment_transport_index.Rd index 73062376e..6509de66d 100644 --- a/man/wbt_sediment_transport_index.Rd +++ b/man/wbt_sediment_transport_index.Rd @@ -11,8 +11,8 @@ wbt_sediment_transport_index( sca_exponent = 0.4, slope_exponent = 1.3, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_sediment_transport_index( \item{slope_exponent}{Slope exponent value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_select_tiles_by_polygon.Rd b/man/wbt_select_tiles_by_polygon.Rd index 530b00247..32b74cee2 100644 --- a/man/wbt_select_tiles_by_polygon.Rd +++ b/man/wbt_select_tiles_by_polygon.Rd @@ -9,8 +9,8 @@ wbt_select_tiles_by_polygon( outdir, polygons, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_select_tiles_by_polygon( \item{polygons}{Input vector polygons file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_set_nodata_value.Rd b/man/wbt_set_nodata_value.Rd index 191a62b4b..56bf7eab7 100644 --- a/man/wbt_set_nodata_value.Rd +++ b/man/wbt_set_nodata_value.Rd @@ -9,8 +9,8 @@ wbt_set_nodata_value( output, back_value = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_set_nodata_value( \item{back_value}{Background value to set to nodata.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_shadow_animation.Rd b/man/wbt_shadow_animation.Rd index 13ce331a2..4005e6fca 100644 --- a/man/wbt_shadow_animation.Rd +++ b/man/wbt_shadow_animation.Rd @@ -16,8 +16,8 @@ wbt_shadow_animation( delay = 250, label = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_shadow_animation( \item{label}{Label text (leave blank for none).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_shadow_image.Rd b/man/wbt_shadow_image.Rd index 7d2d00c0e..583dd8f73 100644 --- a/man/wbt_shadow_image.Rd +++ b/man/wbt_shadow_image.Rd @@ -13,8 +13,8 @@ wbt_shadow_image( time = "13:00", location = "43.5448/-80.2482/-4", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_shadow_image( \item{location}{Location, defined as Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_shape_complexity_index.Rd b/man/wbt_shape_complexity_index.Rd index 73708016c..9e0efedfa 100644 --- a/man/wbt_shape_complexity_index.Rd +++ b/man/wbt_shape_complexity_index.Rd @@ -7,21 +7,21 @@ wbt_shape_complexity_index( input, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } \arguments{ \item{input}{Input vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_shape_complexity_index_raster.Rd b/man/wbt_shape_complexity_index_raster.Rd index 7a501ea89..c8daa9070 100644 --- a/man/wbt_shape_complexity_index_raster.Rd +++ b/man/wbt_shape_complexity_index_raster.Rd @@ -8,8 +8,8 @@ wbt_shape_complexity_index_raster( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_shape_complexity_index_raster( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_shape_index.Rd b/man/wbt_shape_index.Rd index 2cc864eb0..5405d2716 100644 --- a/man/wbt_shape_index.Rd +++ b/man/wbt_shape_index.Rd @@ -9,8 +9,8 @@ wbt_shape_index( output, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_shape_index( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_shreve_stream_magnitude.Rd b/man/wbt_shreve_stream_magnitude.Rd index 4988ae2b2..b6fbfdc37 100644 --- a/man/wbt_shreve_stream_magnitude.Rd +++ b/man/wbt_shreve_stream_magnitude.Rd @@ -11,8 +11,8 @@ wbt_shreve_stream_magnitude( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_shreve_stream_magnitude( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sigmoidal_contrast_stretch.Rd b/man/wbt_sigmoidal_contrast_stretch.Rd index 08a353a18..209857dad 100644 --- a/man/wbt_sigmoidal_contrast_stretch.Rd +++ b/man/wbt_sigmoidal_contrast_stretch.Rd @@ -11,8 +11,8 @@ wbt_sigmoidal_contrast_stretch( gain = 1, num_tones = 256, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_sigmoidal_contrast_stretch( \item{num_tones}{Number of tones in the output image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sin.Rd b/man/wbt_sin.Rd index fae81e18e..2fd926d89 100644 --- a/man/wbt_sin.Rd +++ b/man/wbt_sin.Rd @@ -8,8 +8,8 @@ wbt_sin( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_sin( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_single_part_to_multi_part.Rd b/man/wbt_single_part_to_multi_part.Rd index 042e32fed..cdf31f4ab 100644 --- a/man/wbt_single_part_to_multi_part.Rd +++ b/man/wbt_single_part_to_multi_part.Rd @@ -9,8 +9,8 @@ wbt_single_part_to_multi_part( output, field = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_single_part_to_multi_part( \item{field}{Grouping ID field name in attribute table.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sinh.Rd b/man/wbt_sinh.Rd index c329a8e26..5a217ede6 100644 --- a/man/wbt_sinh.Rd +++ b/man/wbt_sinh.Rd @@ -8,8 +8,8 @@ wbt_sinh( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_sinh( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sink.Rd b/man/wbt_sink.Rd index d23d46ff3..7ef9f9cdd 100644 --- a/man/wbt_sink.Rd +++ b/man/wbt_sink.Rd @@ -9,8 +9,8 @@ wbt_sink( output, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_sink( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_slope.Rd b/man/wbt_slope.Rd index 00e2cd866..0a088cb77 100644 --- a/man/wbt_slope.Rd +++ b/man/wbt_slope.Rd @@ -10,8 +10,8 @@ wbt_slope( zfactor = NULL, units = "degrees", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_slope( \item{units}{Units of output raster; options include 'degrees', 'radians', 'percent'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_slope_vs_aspect_plot.Rd b/man/wbt_slope_vs_aspect_plot.Rd index 93d5ca82e..b08b30c8c 100644 --- a/man/wbt_slope_vs_aspect_plot.Rd +++ b/man/wbt_slope_vs_aspect_plot.Rd @@ -11,8 +11,8 @@ wbt_slope_vs_aspect_plot( min_slope = 0.1, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_slope_vs_aspect_plot( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_slope_vs_elevation_plot.Rd b/man/wbt_slope_vs_elevation_plot.Rd index c93825cf6..66569c5bc 100644 --- a/man/wbt_slope_vs_elevation_plot.Rd +++ b/man/wbt_slope_vs_elevation_plot.Rd @@ -9,8 +9,8 @@ wbt_slope_vs_elevation_plot( output, watershed = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_slope_vs_elevation_plot( \item{watershed}{Input watershed files (optional).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_smooth_vectors.Rd b/man/wbt_smooth_vectors.Rd index 4bd5320db..c01d1f94c 100644 --- a/man/wbt_smooth_vectors.Rd +++ b/man/wbt_smooth_vectors.Rd @@ -9,8 +9,8 @@ wbt_smooth_vectors( output, filter = 3, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_smooth_vectors( \item{filter}{The filter size, any odd integer greater than or equal to 3; default is 3.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_smooth_vegetation_residual.Rd b/man/wbt_smooth_vegetation_residual.Rd index 0d8db6f78..b1827c82a 100644 --- a/man/wbt_smooth_vegetation_residual.Rd +++ b/man/wbt_smooth_vegetation_residual.Rd @@ -11,8 +11,8 @@ wbt_smooth_vegetation_residual( dev_threshold = 1, scale_threshold = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_smooth_vegetation_residual( \item{scale_threshold}{DEVmax scale threshold.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_snap_pour_points.Rd b/man/wbt_snap_pour_points.Rd index b64057af9..b3421ecfe 100644 --- a/man/wbt_snap_pour_points.Rd +++ b/man/wbt_snap_pour_points.Rd @@ -10,8 +10,8 @@ wbt_snap_pour_points( output, snap_dist, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_snap_pour_points( \item{snap_dist}{Maximum snap distance in map units.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sobel_filter.Rd b/man/wbt_sobel_filter.Rd index 508e00fe8..0c4f4ab3c 100644 --- a/man/wbt_sobel_filter.Rd +++ b/man/wbt_sobel_filter.Rd @@ -10,8 +10,8 @@ wbt_sobel_filter( variant = "3x3", clip = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_sobel_filter( \item{clip}{Optional amount to clip the distribution tails by, in percent (default is 0.0).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sort_lidar.Rd b/man/wbt_sort_lidar.Rd index 8fd5ad8cf..fca2282a3 100644 --- a/man/wbt_sort_lidar.Rd +++ b/man/wbt_sort_lidar.Rd @@ -9,8 +9,8 @@ wbt_sort_lidar( output = NULL, criteria = "", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_sort_lidar( \item{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.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_spherical_std_dev_of_normals.Rd b/man/wbt_spherical_std_dev_of_normals.Rd index 0e5748b32..ef4c5aa80 100644 --- a/man/wbt_spherical_std_dev_of_normals.Rd +++ b/man/wbt_spherical_std_dev_of_normals.Rd @@ -9,8 +9,8 @@ wbt_spherical_std_dev_of_normals( output, filter = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_spherical_std_dev_of_normals( \item{filter}{Size of the filter kernel.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_split_colour_composite.Rd b/man/wbt_split_colour_composite.Rd index 6120286f7..8907ac7a3 100644 --- a/man/wbt_split_colour_composite.Rd +++ b/man/wbt_split_colour_composite.Rd @@ -10,8 +10,8 @@ wbt_split_colour_composite( green = NULL, blue = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_split_colour_composite( \item{blue}{Output blue band file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_split_lidar.Rd b/man/wbt_split_lidar.Rd index ba788951c..adebb6bb6 100644 --- a/man/wbt_split_lidar.Rd +++ b/man/wbt_split_lidar.Rd @@ -10,8 +10,8 @@ wbt_split_lidar( interval = "", min_pts = 5, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_split_lidar( \item{min_pts}{Minimum number of points in an output file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_split_vector_lines.Rd b/man/wbt_split_vector_lines.Rd index 8a279e60e..39a197dfe 100644 --- a/man/wbt_split_vector_lines.Rd +++ b/man/wbt_split_vector_lines.Rd @@ -9,8 +9,8 @@ wbt_split_vector_lines( output, length = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_split_vector_lines( \item{length}{Maximum segment length (m).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_split_with_lines.Rd b/man/wbt_split_with_lines.Rd index ab61f4c04..115acc80b 100644 --- a/man/wbt_split_with_lines.Rd +++ b/man/wbt_split_with_lines.Rd @@ -9,8 +9,8 @@ wbt_split_with_lines( split, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_split_with_lines( \item{output}{Output vector file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_square.Rd b/man/wbt_square.Rd index b759817b7..a194f591a 100644 --- a/man/wbt_square.Rd +++ b/man/wbt_square.Rd @@ -8,8 +8,8 @@ wbt_square( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_square( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_square_root.Rd b/man/wbt_square_root.Rd index fc96db6d6..fd8a96d17 100644 --- a/man/wbt_square_root.Rd +++ b/man/wbt_square_root.Rd @@ -8,8 +8,8 @@ wbt_square_root( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_square_root( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_standard_deviation_contrast_stretch.Rd b/man/wbt_standard_deviation_contrast_stretch.Rd index d802c9622..4a3bfbb29 100644 --- a/man/wbt_standard_deviation_contrast_stretch.Rd +++ b/man/wbt_standard_deviation_contrast_stretch.Rd @@ -10,8 +10,8 @@ wbt_standard_deviation_contrast_stretch( stdev = 2, num_tones = 256, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_standard_deviation_contrast_stretch( \item{num_tones}{Number of tones in the output image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_standard_deviation_filter.Rd b/man/wbt_standard_deviation_filter.Rd index d04cad445..37d38f35a 100644 --- a/man/wbt_standard_deviation_filter.Rd +++ b/man/wbt_standard_deviation_filter.Rd @@ -10,8 +10,8 @@ wbt_standard_deviation_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_standard_deviation_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_standard_deviation_of_slope.Rd b/man/wbt_standard_deviation_of_slope.Rd index e3f522423..67146e05f 100644 --- a/man/wbt_standard_deviation_of_slope.Rd +++ b/man/wbt_standard_deviation_of_slope.Rd @@ -11,8 +11,8 @@ wbt_standard_deviation_of_slope( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_standard_deviation_of_slope( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_stochastic_depression_analysis.Rd b/man/wbt_stochastic_depression_analysis.Rd index ae8364b8f..34e8ab794 100644 --- a/man/wbt_stochastic_depression_analysis.Rd +++ b/man/wbt_stochastic_depression_analysis.Rd @@ -11,8 +11,8 @@ wbt_stochastic_depression_analysis( range, iterations = 100, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_stochastic_depression_analysis( \item{iterations}{The number of iterations.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_strahler_order_basins.Rd b/man/wbt_strahler_order_basins.Rd index 7cc0e966e..1d6e4020f 100644 --- a/man/wbt_strahler_order_basins.Rd +++ b/man/wbt_strahler_order_basins.Rd @@ -10,8 +10,8 @@ wbt_strahler_order_basins( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_strahler_order_basins( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_strahler_stream_order.Rd b/man/wbt_strahler_stream_order.Rd index 8e652963d..7dd82f35a 100644 --- a/man/wbt_strahler_stream_order.Rd +++ b/man/wbt_strahler_stream_order.Rd @@ -11,8 +11,8 @@ wbt_strahler_stream_order( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_strahler_stream_order( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_stream_link_class.Rd b/man/wbt_stream_link_class.Rd index fc03d330a..1bab372de 100644 --- a/man/wbt_stream_link_class.Rd +++ b/man/wbt_stream_link_class.Rd @@ -11,8 +11,8 @@ wbt_stream_link_class( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_stream_link_class( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_stream_link_identifier.Rd b/man/wbt_stream_link_identifier.Rd index d567ab20a..acf72ccdd 100644 --- a/man/wbt_stream_link_identifier.Rd +++ b/man/wbt_stream_link_identifier.Rd @@ -11,8 +11,8 @@ wbt_stream_link_identifier( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_stream_link_identifier( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_stream_link_length.Rd b/man/wbt_stream_link_length.Rd index c888b4316..2d3add08e 100644 --- a/man/wbt_stream_link_length.Rd +++ b/man/wbt_stream_link_length.Rd @@ -11,8 +11,8 @@ wbt_stream_link_length( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_stream_link_length( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_stream_link_slope.Rd b/man/wbt_stream_link_slope.Rd index 92f68c352..37a4bafc7 100644 --- a/man/wbt_stream_link_slope.Rd +++ b/man/wbt_stream_link_slope.Rd @@ -12,8 +12,8 @@ wbt_stream_link_slope( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_stream_link_slope( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_stream_power_index.Rd b/man/wbt_stream_power_index.Rd index abd57a204..811eb2031 100644 --- a/man/wbt_stream_power_index.Rd +++ b/man/wbt_stream_power_index.Rd @@ -10,8 +10,8 @@ wbt_stream_power_index( output, exponent = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_stream_power_index( \item{exponent}{SCA exponent value.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_stream_slope_continuous.Rd b/man/wbt_stream_slope_continuous.Rd index 5efdd776c..4a15b312c 100644 --- a/man/wbt_stream_slope_continuous.Rd +++ b/man/wbt_stream_slope_continuous.Rd @@ -12,8 +12,8 @@ wbt_stream_slope_continuous( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_stream_slope_continuous( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_subbasins.Rd b/man/wbt_subbasins.Rd index 5cddc31a7..3d415549b 100644 --- a/man/wbt_subbasins.Rd +++ b/man/wbt_subbasins.Rd @@ -10,8 +10,8 @@ wbt_subbasins( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_subbasins( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_subtract.Rd b/man/wbt_subtract.Rd index e43be718e..bff8f4e49 100644 --- a/man/wbt_subtract.Rd +++ b/man/wbt_subtract.Rd @@ -9,8 +9,8 @@ wbt_subtract( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_subtract( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_sum_overlay.Rd b/man/wbt_sum_overlay.Rd index c77bf8364..208c4d484 100644 --- a/man/wbt_sum_overlay.Rd +++ b/man/wbt_sum_overlay.Rd @@ -8,8 +8,8 @@ wbt_sum_overlay( inputs, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_sum_overlay( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_surface_area_ratio.Rd b/man/wbt_surface_area_ratio.Rd index 37c41f3b9..f1955a618 100644 --- a/man/wbt_surface_area_ratio.Rd +++ b/man/wbt_surface_area_ratio.Rd @@ -8,8 +8,8 @@ wbt_surface_area_ratio( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_surface_area_ratio( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_svm_classification.Rd b/man/wbt_svm_classification.Rd index 445892179..e74bd0bda 100644 --- a/man/wbt_svm_classification.Rd +++ b/man/wbt_svm_classification.Rd @@ -15,8 +15,8 @@ wbt_svm_classification( tolerance = 0.1, test_proportion = 0.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_svm_classification( \item{test_proportion}{The proportion of the dataset to include in the test split; default is 0.2.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_svm_regression.Rd b/man/wbt_svm_regression.Rd index 1c0907910..3fb0491ba 100644 --- a/man/wbt_svm_regression.Rd +++ b/man/wbt_svm_regression.Rd @@ -15,8 +15,8 @@ wbt_svm_regression( gamma = 0.5, test_proportion = 0.2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -39,13 +39,13 @@ wbt_svm_regression( \item{test_proportion}{The proportion of the dataset to include in the test split; default is 0.2.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_symmetrical_difference.Rd b/man/wbt_symmetrical_difference.Rd index 1a49ce706..70df0e88c 100644 --- a/man/wbt_symmetrical_difference.Rd +++ b/man/wbt_symmetrical_difference.Rd @@ -10,8 +10,8 @@ wbt_symmetrical_difference( output, snap = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_symmetrical_difference( \item{snap}{Snap tolerance.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_tan.Rd b/man/wbt_tan.Rd index d3801dd32..959f51054 100644 --- a/man/wbt_tan.Rd +++ b/man/wbt_tan.Rd @@ -8,8 +8,8 @@ wbt_tan( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_tan( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_tangential_curvature.Rd b/man/wbt_tangential_curvature.Rd index e0fc3f13d..32771fbf6 100644 --- a/man/wbt_tangential_curvature.Rd +++ b/man/wbt_tangential_curvature.Rd @@ -10,8 +10,8 @@ wbt_tangential_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_tangential_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_tanh.Rd b/man/wbt_tanh.Rd index fc679e51d..184159285 100644 --- a/man/wbt_tanh.Rd +++ b/man/wbt_tanh.Rd @@ -8,8 +8,8 @@ wbt_tanh( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_tanh( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_thicken_raster_line.Rd b/man/wbt_thicken_raster_line.Rd index 16117518a..bbd207cdd 100644 --- a/man/wbt_thicken_raster_line.Rd +++ b/man/wbt_thicken_raster_line.Rd @@ -8,8 +8,8 @@ wbt_thicken_raster_line( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_thicken_raster_line( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_time_in_daylight.Rd b/man/wbt_time_in_daylight.Rd index 8cd745e7d..f1eec75a5 100644 --- a/man/wbt_time_in_daylight.Rd +++ b/man/wbt_time_in_daylight.Rd @@ -17,8 +17,8 @@ wbt_time_in_daylight( start_time = "00:00:00", end_time = "23:59:59", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -45,13 +45,13 @@ wbt_time_in_daylight( \item{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.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_tin_gridding.Rd b/man/wbt_tin_gridding.Rd index 305a7c442..24b665a12 100644 --- a/man/wbt_tin_gridding.Rd +++ b/man/wbt_tin_gridding.Rd @@ -13,8 +13,8 @@ wbt_tin_gridding( base = NULL, max_triangle_edge_length = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_tin_gridding( \item{max_triangle_edge_length}{Optional maximum triangle edge length; triangles larger than this size will not be gridded.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_to_degrees.Rd b/man/wbt_to_degrees.Rd index 2f85ae3c5..4f2140fef 100644 --- a/man/wbt_to_degrees.Rd +++ b/man/wbt_to_degrees.Rd @@ -8,8 +8,8 @@ wbt_to_degrees( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_to_degrees( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_to_radians.Rd b/man/wbt_to_radians.Rd index 1b74d57df..c21103d88 100644 --- a/man/wbt_to_radians.Rd +++ b/man/wbt_to_radians.Rd @@ -8,8 +8,8 @@ wbt_to_radians( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_to_radians( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_tophat_transform.Rd b/man/wbt_tophat_transform.Rd index 3c8210c44..e895a3a24 100644 --- a/man/wbt_tophat_transform.Rd +++ b/man/wbt_tophat_transform.Rd @@ -11,8 +11,8 @@ wbt_tophat_transform( filtery = 11, variant = "white", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_tophat_transform( \item{variant}{Optional variant value. Options include 'white' and 'black'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_topo_render.Rd b/man/wbt_topo_render.Rd index 1b2e317db..7f87061d9 100644 --- a/man/wbt_topo_render.Rd +++ b/man/wbt_topo_render.Rd @@ -18,8 +18,8 @@ wbt_topo_render( ambient_light = 0.2, z_factor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -48,13 +48,13 @@ wbt_topo_render( \item{z_factor}{Elevation multiplier, or a vertical exageration.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_topographic_position_animation.Rd b/man/wbt_topographic_position_animation.Rd index 50ea5acf0..1d25b6c51 100644 --- a/man/wbt_topographic_position_animation.Rd +++ b/man/wbt_topographic_position_animation.Rd @@ -16,8 +16,8 @@ wbt_topographic_position_animation( label = "", dev_max = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -42,13 +42,13 @@ wbt_topographic_position_animation( \item{dev_max}{Do you want to use DEVmax instead of DEV for measuring local topographic position?.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_topological_stream_order.Rd b/man/wbt_topological_stream_order.Rd index 7e58ab775..d6eeb1ed5 100644 --- a/man/wbt_topological_stream_order.Rd +++ b/man/wbt_topological_stream_order.Rd @@ -11,8 +11,8 @@ wbt_topological_stream_order( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_topological_stream_order( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_total_curvature.Rd b/man/wbt_total_curvature.Rd index 8058f49af..4bf0b4af5 100644 --- a/man/wbt_total_curvature.Rd +++ b/man/wbt_total_curvature.Rd @@ -10,8 +10,8 @@ wbt_total_curvature( log = FALSE, zfactor = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_total_curvature( \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_total_filter.Rd b/man/wbt_total_filter.Rd index 04558cbf1..88be1793f 100644 --- a/man/wbt_total_filter.Rd +++ b/man/wbt_total_filter.Rd @@ -10,8 +10,8 @@ wbt_total_filter( filterx = 11, filtery = 11, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_total_filter( \item{filtery}{Size of the filter kernel in the y-direction.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_trace_downslope_flowpaths.Rd b/man/wbt_trace_downslope_flowpaths.Rd index 4184f1170..a1fefa2ee 100644 --- a/man/wbt_trace_downslope_flowpaths.Rd +++ b/man/wbt_trace_downslope_flowpaths.Rd @@ -11,8 +11,8 @@ wbt_trace_downslope_flowpaths( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_trace_downslope_flowpaths( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_travelling_salesman_problem.Rd b/man/wbt_travelling_salesman_problem.Rd index f9189d6fa..081b7cccf 100644 --- a/man/wbt_travelling_salesman_problem.Rd +++ b/man/wbt_travelling_salesman_problem.Rd @@ -9,8 +9,8 @@ wbt_travelling_salesman_problem( output, duration = 60, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_travelling_salesman_problem( \item{duration}{Maximum duration, in seconds.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_trend_surface.Rd b/man/wbt_trend_surface.Rd index ac1c6b7c2..8a4019d6e 100644 --- a/man/wbt_trend_surface.Rd +++ b/man/wbt_trend_surface.Rd @@ -9,8 +9,8 @@ wbt_trend_surface( output, order = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_trend_surface( \item{order}{Polynomial order (1 to 10).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_trend_surface_vector_points.Rd b/man/wbt_trend_surface_vector_points.Rd index 179651354..c0bd36fd6 100644 --- a/man/wbt_trend_surface_vector_points.Rd +++ b/man/wbt_trend_surface_vector_points.Rd @@ -11,8 +11,8 @@ wbt_trend_surface_vector_points( cell_size, order = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_trend_surface_vector_points( \item{order}{Polynomial order (1 to 10).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_tributary_identifier.Rd b/man/wbt_tributary_identifier.Rd index 51694a077..da21089d6 100644 --- a/man/wbt_tributary_identifier.Rd +++ b/man/wbt_tributary_identifier.Rd @@ -11,8 +11,8 @@ wbt_tributary_identifier( esri_pntr = FALSE, zero_background = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_tributary_identifier( \item{zero_background}{Flag indicating whether a background value of zero should be used.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_truncate.Rd b/man/wbt_truncate.Rd index 1a012eef2..17aaf796d 100644 --- a/man/wbt_truncate.Rd +++ b/man/wbt_truncate.Rd @@ -9,8 +9,8 @@ wbt_truncate( output, num_decimals = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_truncate( \item{num_decimals}{Number of decimals left after truncation (default is zero).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_turning_bands_simulation.Rd b/man/wbt_turning_bands_simulation.Rd index 108fe674b..af8a32c2c 100644 --- a/man/wbt_turning_bands_simulation.Rd +++ b/man/wbt_turning_bands_simulation.Rd @@ -10,8 +10,8 @@ wbt_turning_bands_simulation( range, iterations = 1000, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_turning_bands_simulation( \item{iterations}{The number of iterations.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_two_sample_ks_test.Rd b/man/wbt_two_sample_ks_test.Rd index 21a91f34c..c5bf12fbf 100644 --- a/man/wbt_two_sample_ks_test.Rd +++ b/man/wbt_two_sample_ks_test.Rd @@ -10,8 +10,8 @@ wbt_two_sample_ks_test( output, num_samples = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_two_sample_ks_test( \item{num_samples}{Number of samples. Leave blank to use whole image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_union.Rd b/man/wbt_union.Rd index eaf9d55be..01a0f3f07 100644 --- a/man/wbt_union.Rd +++ b/man/wbt_union.Rd @@ -10,8 +10,8 @@ wbt_union( output, snap = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_union( \item{snap}{Snap tolerance.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_unnest_basins.Rd b/man/wbt_unnest_basins.Rd index 423a1ff84..2fa2f920b 100644 --- a/man/wbt_unnest_basins.Rd +++ b/man/wbt_unnest_basins.Rd @@ -10,8 +10,8 @@ wbt_unnest_basins( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_unnest_basins( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_unsharp_masking.Rd b/man/wbt_unsharp_masking.Rd index bd958698d..a044f6bb3 100644 --- a/man/wbt_unsharp_masking.Rd +++ b/man/wbt_unsharp_masking.Rd @@ -11,8 +11,8 @@ wbt_unsharp_masking( amount = 100, threshold = 0, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_unsharp_masking( \item{threshold}{Controls the minimal brightness change that will be sharpened.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_unsphericity.Rd b/man/wbt_unsphericity.Rd index fb33725c7..62d4ec7d4 100644 --- a/man/wbt_unsphericity.Rd +++ b/man/wbt_unsphericity.Rd @@ -10,8 +10,8 @@ wbt_unsphericity( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_unsphericity( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_update_nodata_cells.Rd b/man/wbt_update_nodata_cells.Rd index 71070496c..0bb27416d 100644 --- a/man/wbt_update_nodata_cells.Rd +++ b/man/wbt_update_nodata_cells.Rd @@ -9,8 +9,8 @@ wbt_update_nodata_cells( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_update_nodata_cells( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_upslope_depression_storage.Rd b/man/wbt_upslope_depression_storage.Rd index 76b129b32..3b9f0c93d 100644 --- a/man/wbt_upslope_depression_storage.Rd +++ b/man/wbt_upslope_depression_storage.Rd @@ -8,8 +8,8 @@ wbt_upslope_depression_storage( dem, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_upslope_depression_storage( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_user_defined_weights_filter.Rd b/man/wbt_user_defined_weights_filter.Rd index 1b7939c0d..f47a10023 100644 --- a/man/wbt_user_defined_weights_filter.Rd +++ b/man/wbt_user_defined_weights_filter.Rd @@ -11,8 +11,8 @@ wbt_user_defined_weights_filter( center = "center", normalize = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_user_defined_weights_filter( \item{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.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_vector_hex_binning.Rd b/man/wbt_vector_hex_binning.Rd index 2282bfc3d..8b07f6e36 100644 --- a/man/wbt_vector_hex_binning.Rd +++ b/man/wbt_vector_hex_binning.Rd @@ -10,8 +10,8 @@ wbt_vector_hex_binning( width, orientation = "horizontal", wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_vector_hex_binning( \item{orientation}{Grid Orientation, 'horizontal' or 'vertical'.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_vector_lines_to_raster.Rd b/man/wbt_vector_lines_to_raster.Rd index 9f7d71d01..0b236cf1c 100644 --- a/man/wbt_vector_lines_to_raster.Rd +++ b/man/wbt_vector_lines_to_raster.Rd @@ -12,8 +12,8 @@ wbt_vector_lines_to_raster( cell_size = NULL, base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_vector_lines_to_raster( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_vector_points_to_raster.Rd b/man/wbt_vector_points_to_raster.Rd index 7e28d1773..46c5559e6 100644 --- a/man/wbt_vector_points_to_raster.Rd +++ b/man/wbt_vector_points_to_raster.Rd @@ -13,8 +13,8 @@ wbt_vector_points_to_raster( cell_size = NULL, base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_vector_points_to_raster( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_vector_polygons_to_raster.Rd b/man/wbt_vector_polygons_to_raster.Rd index 79de1c4a6..2e6f8fd91 100644 --- a/man/wbt_vector_polygons_to_raster.Rd +++ b/man/wbt_vector_polygons_to_raster.Rd @@ -12,8 +12,8 @@ wbt_vector_polygons_to_raster( cell_size = NULL, base = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_vector_polygons_to_raster( \item{base}{Optionally specified input base raster file. Not used when a cell size is specified.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_vector_stream_network_analysis.Rd b/man/wbt_vector_stream_network_analysis.Rd index 174d7e505..119c38bd8 100644 --- a/man/wbt_vector_stream_network_analysis.Rd +++ b/man/wbt_vector_stream_network_analysis.Rd @@ -11,8 +11,8 @@ wbt_vector_stream_network_analysis( cutting_height = 10, snap = 0.1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_vector_stream_network_analysis( \item{snap}{Snap distance, in xy units (metres).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_vertical_excess_curvature.Rd b/man/wbt_vertical_excess_curvature.Rd index 04ca420a9..54bcae1fd 100644 --- a/man/wbt_vertical_excess_curvature.Rd +++ b/man/wbt_vertical_excess_curvature.Rd @@ -10,8 +10,8 @@ wbt_vertical_excess_curvature( log = FALSE, zfactor = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_vertical_excess_curvature( \item{zfactor}{Z conversion factor.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_viewshed.Rd b/man/wbt_viewshed.Rd index 2f105be4e..a0224e473 100644 --- a/man/wbt_viewshed.Rd +++ b/man/wbt_viewshed.Rd @@ -10,8 +10,8 @@ wbt_viewshed( output, height = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_viewshed( \item{height}{Viewing station height, in z units.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_visibility_index.Rd b/man/wbt_visibility_index.Rd index 3f6c579ad..a882a668b 100644 --- a/man/wbt_visibility_index.Rd +++ b/man/wbt_visibility_index.Rd @@ -10,8 +10,8 @@ wbt_visibility_index( height = 2, res_factor = 2, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_visibility_index( \item{res_factor}{The resolution factor determines the density of measured viewsheds.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_voronoi_diagram.Rd b/man/wbt_voronoi_diagram.Rd index f3a10b488..cb3ac0d91 100644 --- a/man/wbt_voronoi_diagram.Rd +++ b/man/wbt_voronoi_diagram.Rd @@ -8,8 +8,8 @@ wbt_voronoi_diagram( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_voronoi_diagram( \item{output}{Output vector polygon file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_watershed.Rd b/man/wbt_watershed.Rd index 5380de9df..d24b504e4 100644 --- a/man/wbt_watershed.Rd +++ b/man/wbt_watershed.Rd @@ -10,8 +10,8 @@ wbt_watershed( output, esri_pntr = FALSE, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_watershed( \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_weighted_overlay.Rd b/man/wbt_weighted_overlay.Rd index e06abf282..982f5fc57 100644 --- a/man/wbt_weighted_overlay.Rd +++ b/man/wbt_weighted_overlay.Rd @@ -12,8 +12,8 @@ wbt_weighted_overlay( constraints = NULL, scale_max = 1, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -30,13 +30,13 @@ wbt_weighted_overlay( \item{scale_max}{Suitability scale maximum value (common values are 1.0, 100.0, and 255.0).} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_weighted_sum.Rd b/man/wbt_weighted_sum.Rd index 579cdd0a7..a2862fd80 100644 --- a/man/wbt_weighted_sum.Rd +++ b/man/wbt_weighted_sum.Rd @@ -9,8 +9,8 @@ wbt_weighted_sum( weights, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_weighted_sum( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_wetness_index.Rd b/man/wbt_wetness_index.Rd index a9a86dc94..0923cc7ef 100644 --- a/man/wbt_wetness_index.Rd +++ b/man/wbt_wetness_index.Rd @@ -9,8 +9,8 @@ wbt_wetness_index( slope, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_wetness_index( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_wilcoxon_signed_rank_test.Rd b/man/wbt_wilcoxon_signed_rank_test.Rd index 500f995e3..aa266d1fd 100644 --- a/man/wbt_wilcoxon_signed_rank_test.Rd +++ b/man/wbt_wilcoxon_signed_rank_test.Rd @@ -10,8 +10,8 @@ wbt_wilcoxon_signed_rank_test( output, num_samples = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_wilcoxon_signed_rank_test( \item{num_samples}{Number of samples. Leave blank to use whole image.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_write_function_memory_insertion.Rd b/man/wbt_write_function_memory_insertion.Rd index 2c56c3dcf..d2916b0fb 100644 --- a/man/wbt_write_function_memory_insertion.Rd +++ b/man/wbt_write_function_memory_insertion.Rd @@ -10,8 +10,8 @@ wbt_write_function_memory_insertion( output, input3 = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -24,13 +24,13 @@ wbt_write_function_memory_insertion( \item{input3}{Optional input raster file associated with the third date.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_xor.Rd b/man/wbt_xor.Rd index 7c72e29b9..c53ecb544 100644 --- a/man/wbt_xor.Rd +++ b/man/wbt_xor.Rd @@ -9,8 +9,8 @@ wbt_xor( input2, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -21,13 +21,13 @@ wbt_xor( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_yield_filter.Rd b/man/wbt_yield_filter.Rd index 1e8f4a364..d1fdad5b6 100644 --- a/man/wbt_yield_filter.Rd +++ b/man/wbt_yield_filter.Rd @@ -14,8 +14,8 @@ wbt_yield_filter( min_yield = 0, max_yield = 99999.9, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -36,13 +36,13 @@ wbt_yield_filter( \item{max_yield}{Maximum yield value in output.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_yield_map.Rd b/man/wbt_yield_map.Rd index ef5360949..714430235 100644 --- a/man/wbt_yield_map.Rd +++ b/man/wbt_yield_map.Rd @@ -11,8 +11,8 @@ wbt_yield_map( width = 6.096, max_change_in_heading = 25, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_yield_map( \item{max_change_in_heading}{Max change in heading.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_yield_normalization.Rd b/man/wbt_yield_normalization.Rd index 7ce8ffc1c..f29c4a4e6 100644 --- a/man/wbt_yield_normalization.Rd +++ b/man/wbt_yield_normalization.Rd @@ -13,8 +13,8 @@ wbt_yield_normalization( min_yield = 0, max_yield = 99999.9, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -33,13 +33,13 @@ wbt_yield_normalization( \item{max_yield}{Maximum yield value in output.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_z_scores.Rd b/man/wbt_z_scores.Rd index 55eedcab4..daaeef2b1 100644 --- a/man/wbt_z_scores.Rd +++ b/man/wbt_z_scores.Rd @@ -8,8 +8,8 @@ wbt_z_scores( input, output, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_z_scores( \item{output}{Output raster file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_zlidar_to_las.Rd b/man/wbt_zlidar_to_las.Rd index d15fc019b..80c27bbb4 100644 --- a/man/wbt_zlidar_to_las.Rd +++ b/man/wbt_zlidar_to_las.Rd @@ -8,8 +8,8 @@ wbt_zlidar_to_las( inputs = NULL, outdir = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -18,13 +18,13 @@ wbt_zlidar_to_las( \item{outdir}{Output directory into which zlidar files are created. If unspecified, it is assumed to be the same as the inputs.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. diff --git a/man/wbt_zonal_statistics.Rd b/man/wbt_zonal_statistics.Rd index 3313d8887..93576954b 100644 --- a/man/wbt_zonal_statistics.Rd +++ b/man/wbt_zonal_statistics.Rd @@ -11,8 +11,8 @@ wbt_zonal_statistics( stat = "mean", out_table = NULL, wd = NULL, - verbose_mode = FALSE, - compress_rasters = FALSE, + verbose_mode = NULL, + compress_rasters = NULL, command_only = FALSE ) } @@ -27,13 +27,13 @@ wbt_zonal_statistics( \item{out_table}{Output HTML Table file.} -\item{wd}{Changes the working directory.} +\item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} -\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages.} +\item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} -\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.} +\item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} -\item{command_only}{Return command that would be executed by \code{system()} rather than running tool.} +\item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} } \value{ Returns the tool text outputs. From 5711dae40f6a12dbe2edd1fff74bc405b2a2135b Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Sun, 1 Oct 2023 09:28:10 -0700 Subject: [PATCH 4/7] Update wbt_options docs --- R/wbt.R | 16 ++++++++-------- man/wbt_init.Rd | 14 +++++++------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/R/wbt.R b/R/wbt.R index fd5c8e435..29ff98737 100644 --- a/R/wbt.R +++ b/R/wbt.R @@ -101,9 +101,9 @@ wbt_init <- function(exe_path = wbt_exe_path(shell_quote = FALSE), #' #' - **`whitebox.wd`** - character. Path to WhiteboxTools working directory. Used as `--wd` argument for tools that support it when `wd` is not specified elsewhere. #' -#' - **`whitebox.verbose`** - logical. Should standard output from calls to executable be `cat()` out for readability? Default is result of `interactive()`. Individual tools may have `verbose_mode` setting that produce only single-line output when `FALSE`. These argument values are left as the defaults defined in the package documentation for that function. When `whitebox.verbose=FALSE` no output is produced. Set the value of `whitebox.verbose` with `wbt_verbose()` `verbose` argument. +#' - **`whitebox.verbose`** - logical. Should standard output from calls to executable be `cat()` out for readability? When `whitebox.verbose=FALSE` no output is produced. Set the value of `whitebox.verbose` with `wbt_verbose()` `verbose` argument. Default is result of `interactive()` if R package options are unset. #' -#' - **`whitebox.compress_rasters`** - logical. Should raster output from WhiteboxTools be compressed? Default: `FALSE`. Set the value of `whitebox.compress_rasters` with `wbt_compress_rasters()` `compress_rasters` argument. +#' - **`whitebox.compress_rasters`** - logical. Should raster output from WhiteboxTools be compressed? Default: `NULL` uses existing WhiteboxTools settings. Set the value of `whitebox.compress_rasters` with `wbt_compress_rasters()` `compress_rasters` argument. #' #' - **`whitebox.max_procs`** - integer. Maximum number of processes for tools that run in parallel or partially parallelize. Default: `-1` uses all of the available cores. #' @@ -172,7 +172,7 @@ wbt_options <- function(exe_path = NULL, sysvrb), whitebox.compress_rasters = ifelse(nchar(syscpr) == 0, as.logical(getOption("whitebox.compress_rasters", - default = FALSE)), + default = NA)), syscpr), whitebox.max_proc = ifelse(nchar(sysmxp) == 0, as.integer(getOption("whitebox.max_proc", @@ -354,9 +354,9 @@ wbt_wd <- function(wd = NULL) { #' @description `wbt_verbose()`: Check verbose options for 'WhiteboxTools' #' -#' @param verbose Default: `NULL`; if logical, set the package option `whitebox.verbose` to specified value +#' @param verbose logical. Default: `NULL`; if `TRUE` or `FALSE`, set the package option `whitebox.verbose` to specified value. Tool verbosity settings can be overridden in any `wbt_*()` function call by passing the `verbose_mode` argument directly. #' -#' @return `wbt_verbose()`: logical; defaults to result of `interactive()` +#' @return `wbt_verbose()`: logical; returns the result of option `"whitebox.verbose_mode"`, if unset defaults to result of `interactive()`. #' @rdname wbt_init #' @export #' @keywords General @@ -411,11 +411,11 @@ wbt_verbose <- function(verbose = NULL) { invisible(res) } -#' @description `wbt_compress_rasters()`: Check raster compression option for 'WhiteboxTools'. Default: `FALSE` +#' @description `wbt_compress_rasters()`: Check raster compression option for 'WhiteboxTools'. Default behavior is based on WhiteboxTools settings.json, package options (if set). Raster compression settings can be overridden in any `wbt_*()` function call by passing the `compress_rasters` argument directly. #' -#' @param compress_rasters Default: `NULL`; if logical, set the package option `whitebox.compress_rasters` to specified value +#' @param compress_rasters logical. Default: `NULL`; if `TRUE` or `FALSE`, set the package option `whitebox.compress_rasters` to specified value. #' -#' @return `wbt_compress_rasters()`: logical; defaults to `NA` +#' @return `wbt_compress_rasters()`: logical; returns the result of option `"whitebox.compress_rasters"`, if unset defaults to `NA`. #' @rdname wbt_init #' @export #' @keywords General diff --git a/man/wbt_init.Rd b/man/wbt_init.Rd index 93499baa6..4b762d08f 100644 --- a/man/wbt_init.Rd +++ b/man/wbt_init.Rd @@ -52,9 +52,9 @@ wbt_max_procs(max_procs = NULL) \item{wd}{character; Default: \code{NULL}; if set the package option \code{whitebox.wd} is set specified path (if directory exists)} -\item{verbose}{Default: \code{NULL}; if logical, set the package option \code{whitebox.verbose} to specified value} +\item{verbose}{logical. Default: \code{NULL}; if \code{TRUE} or \code{FALSE}, set the package option \code{whitebox.verbose} to specified value. Tool verbosity settings can be overridden in any \verb{wbt_*()} function call by passing the \code{verbose_mode} argument directly.} -\item{compress_rasters}{Default: \code{NULL}; if logical, set the package option \code{whitebox.compress_rasters} to specified value} +\item{compress_rasters}{logical. Default: \code{NULL}; if \code{TRUE} or \code{FALSE}, set the package option \code{whitebox.compress_rasters} to specified value.} \item{max_procs}{Default: \code{NULL}; if integer, set the package option \code{whitebox.max_procs} to specified value} @@ -69,9 +69,9 @@ Returns the file path of 'WhiteboxTools' executable. \code{wbt_wd()}: character; when working directory is unset, will not add \verb{--wd=} arguments to calls and should be the same as using \code{getwd()}. See Details. -\code{wbt_verbose()}: logical; defaults to result of \code{interactive()} +\code{wbt_verbose()}: logical; returns the result of option \code{"whitebox.verbose_mode"}, if unset defaults to result of \code{interactive()}. -\code{wbt_compress_rasters()}: logical; defaults to \code{NA} +\code{wbt_compress_rasters()}: logical; returns the result of option \code{"whitebox.compress_rasters"}, if unset defaults to \code{NA}. \code{wbt_max_procs()}: integer; defaults to \code{NA_integer_} } @@ -82,8 +82,8 @@ Returns the file path of 'WhiteboxTools' executable. \itemize{ \item \strong{\code{whitebox.exe_path}} - character. Path to executable file. The default value is the package installation directory, subdirectory \code{"WBT"}, followed by \code{whitebox_tools.exe} or \code{whitebox_tools}. Set the \code{whitebox.exe_path} option using \code{wbt_init()} \code{exe_path} argument \item \strong{\code{whitebox.wd}} - character. Path to WhiteboxTools working directory. Used as \code{--wd} argument for tools that support it when \code{wd} is not specified elsewhere. -\item \strong{\code{whitebox.verbose}} - logical. Should standard output from calls to executable be \code{cat()} out for readability? Default is result of \code{interactive()}. Individual tools may have \code{verbose_mode} setting that produce only single-line output when \code{FALSE}. These argument values are left as the defaults defined in the package documentation for that function. When \code{whitebox.verbose=FALSE} no output is produced. Set the value of \code{whitebox.verbose} with \code{wbt_verbose()} \code{verbose} argument. -\item \strong{\code{whitebox.compress_rasters}} - logical. Should raster output from WhiteboxTools be compressed? Default: \code{FALSE}. Set the value of \code{whitebox.compress_rasters} with \code{wbt_compress_rasters()} \code{compress_rasters} argument. +\item \strong{\code{whitebox.verbose}} - logical. Should standard output from calls to executable be \code{cat()} out for readability? When \code{whitebox.verbose=FALSE} no output is produced. Set the value of \code{whitebox.verbose} with \code{wbt_verbose()} \code{verbose} argument. Default is result of \code{interactive()} if R package options are unset. +\item \strong{\code{whitebox.compress_rasters}} - logical. Should raster output from WhiteboxTools be compressed? Default: \code{NULL} uses existing WhiteboxTools settings. Set the value of \code{whitebox.compress_rasters} with \code{wbt_compress_rasters()} \code{compress_rasters} argument. \item \strong{\code{whitebox.max_procs}} - integer. Maximum number of processes for tools that run in parallel or partially parallelize. Default: \code{-1} uses all of the available cores. } @@ -99,7 +99,7 @@ Returns the file path of 'WhiteboxTools' executable. \code{wbt_verbose()}: Check verbose options for 'WhiteboxTools' -\code{wbt_compress_rasters()}: Check raster compression option for 'WhiteboxTools'. Default: \code{FALSE} +\code{wbt_compress_rasters()}: Check raster compression option for 'WhiteboxTools'. Default behavior is based on WhiteboxTools settings.json, package options (if set). Raster compression settings can be overridden in any \verb{wbt_*()} function call by passing the \code{compress_rasters} argument directly. \code{wbt_max_procs()}: Check maximum number of processes for for tools that run in parallel or partially parallelize. Default: \code{-1} uses all of the available cores. } From afe5bcd77208bc6488389d071e0d526c50e31248 Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Tue, 3 Oct 2023 05:47:13 -0700 Subject: [PATCH 5/7] Update DESCRIPTION --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 05ec8f6ea..d0be5bccd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: whitebox Type: Package Title: 'WhiteboxTools' R Frontend -Version: 2.3.2 +Version: 2.3.3 Description: An R frontend for the 'WhiteboxTools' library, which is an advanced geospatial data analysis platform developed by Prof. John Lindsay at the University of Guelph's Geomorphometry and Hydrogeomatics Research Group. 'WhiteboxTools' can be used to perform common geographical information systems (GIS) analysis operations, such as cost-distance analysis, distance buffering, and raster reclassification. Remote sensing and image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), and common image transformations. 'WhiteboxTools' also contains advanced tooling for spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices such as slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), and LiDAR data processing. Suggested citation: Lindsay (2016) . Authors@R: c(person("Qiusheng", "Wu", email = "giswqs@gmail.com", role = c("aut")), person("Andrew", "Brown", email = "brown.andrewg@gmail.com", role = c("ctb", "cre"))) From 2995aaaefe2299a47fdc5c3744f0fd8777479b85 Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Tue, 3 Oct 2023 05:50:56 -0700 Subject: [PATCH 6/7] Update NEWS.md --- NEWS.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/NEWS.md b/NEWS.md index bcb637d63..a36f32d24 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,9 @@ +# whitebox 2.3.3 + + * The default values for `compress_rasters` and `verbose_mode` have been set to NULL to better reflect that they are derived from the WhiteboxTools settings.json file. + + * See `wbt_options()` for more details. If the user specifiesthese arguments in a `wbt_*()` function call then the flag will be passed in the command line call. Otherwise the default `NULL` value is ignored. Links to the corresponding option-setting functions have been added to the documentation for all `wbt_*()` tool functions. + # whitebox 2.3.2 * Fix for file paths passed to optional `base` argument of `wbt_resample()`; thanks to @Pentaonia for reporting From 687bd6353edb6e7844d5edbc99a697704239e349 Mon Sep 17 00:00:00 2001 From: Andrew Gene Brown Date: Tue, 3 Oct 2023 05:51:29 -0700 Subject: [PATCH 7/7] Update NEWS.md [skip ci] --- NEWS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index a36f32d24..ac194c5a7 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,7 @@ * The default values for `compress_rasters` and `verbose_mode` have been set to NULL to better reflect that they are derived from the WhiteboxTools settings.json file. - * See `wbt_options()` for more details. If the user specifiesthese arguments in a `wbt_*()` function call then the flag will be passed in the command line call. Otherwise the default `NULL` value is ignored. Links to the corresponding option-setting functions have been added to the documentation for all `wbt_*()` tool functions. + * See `wbt_options()` for more details. If the user specifies these arguments in a `wbt_*()` function call then the flag will be passed in the command line call. Otherwise the default `NULL` value is ignored. Links to the corresponding option-setting functions have been added to the documentation for all `wbt_*()` tool functions. # whitebox 2.3.2