CRAN Release 2.4.0

whitebox 2.4.0

• Updates for WhiteboxTools v2.4.0 (https://github.com/jblindsay/whitebox-tools/releases/tag/v2.4.0)

• Fix for new ZIP file folder structure for WhiteboxTools v2.4.0+ in wbt_install() / install_whitebox()

What's Changed

• Add website to DESCRIPTION + update config by @olivroy in #122
• whitebox 2.4.0 by @brownag in #124

New Contributors

• @olivroy made their first contribution in #122

Full Changelog: v2.3.4...v2.4.0

CRAN Release 2.3.4

whitebox 2.3.4

• Exported wbt_file_path(), a function previously used internally for creating safe, expanded, quoted, paths for building WhiteboxTools commands. This function also supports the input of terra objects that are backed by file sources supported by WhiteboxTools.

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 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

• Fix for file paths passed to optional base argument of wbt_resample(); thanks to @Pentaonia for reporting

  • Also fixed are: wbt_vector_lines_to_raster(), wbt_vector_points_to_raster(), wbt_vector_polygons_to_raster(), wbt_block_maximum_gridding(), wbt_block_minimum_gridding(), wbt_heat_map(), wbt_idw_interpolation(), wbt_natural_neighbour_interpolation(), wbt_nearest_neighbour_gridding(), wbt_radial_basis_function_interpolation(), wbt_tin_gridding()

What's Changed

• wbt_* base argument by @brownag in #113
• Doc update v2.3.3 by @brownag in #117
• wbt_file_path: add support for terra objects that have a file source by @brownag in #121

Full Changelog: v2.3.1...v2.3.4

CRAN Release 2.3.1

whitebox 2.3.1

• wbt_install() and wbt_install_extension() gain optional platform argument that is used as a suffix on ZIP file, allowing download of alternate binaries on Linux and macOS (Darwin).

• Add wbt_runner_path() (analog of wbt_exe_path() for whitebox_runner GUI executable) and wbt_launch_runner() a simple function to launch the GUI.

• wbt_wd("") now sets the value of working_directory in the WhiteboxTools settings.json file to "" and triggers background options to prevent --wd flag being added until a new working directory is set. This has been a long-standing issue, resolved following #108.

CRAN Release 2.3.0

whitebox 2.3.0

• Updates for WhiteboxTools v2.3.0 (https://github.com/jblindsay/whitebox-tools/releases/tag/v2.3.0)

• Add wbt(), wbt_source(), and related methods; new functionality for calling tools by name with various R object types as input.

  • See the wbt() method vignette for details.

---

Also new on CRAN are the changes from v2.2.1 shown below:

whitebox 2.2.1

• Adds wbt_data_dir() for managing where WhiteboxTools "WBT" directory is installed.

  • The new default path is a preferred location generated with tools::R_user_dir(package="whitebox") on R 4.0+

  • If "whitebox_tools" is found on your PATH, you no longer need any custom setup of whitebox.exe_path. The path and options will be detected automatically via Sys.which("whitebox_tools").

  • Custom options set within the session or environment take precedence over PATH.

What's Changed

• whitebox v2.2.1 by @brownag in #95
• Docs v2.2.1 by @brownag in #99
• whitebox v2.3.0 by @brownag in #100

Full Changelog: v2.2.0...v2.3.0

CRAN Release 2.2.0

whitebox 2.2.0

• Updates for WhiteboxTools v2.2.0 (see https://www.whiteboxgeo.com/ for details)

• wbt_rust_backtrace(), a helper method for debugging Rust-related failures of the command-line tool, is now exported

• wbt_run_tool(): Fix potentially length > 1 logic in if() statement for error status messages to avoid warnings/future errors

• download.file() method="wininet" has been deprecated so it is no longer in the possible set of methods to try on Windows when a download fails

CRAN Release 2.1.5

whitebox 2.1.5

• Added wbt_install_extension() and wbt_activate() for downloading, installing and activating WhiteboxTools extensions

• wbt_internal_tool_name() now returns tool names in CamelCase, and these are the tool names passed via the command line

CRAN Release 2.1.4

whitebox 2.1.4

• Suggest {terra} instead of {raster} and update demo vignette accordingly; drops {rgdal} suggest

• Add support for path expansion in wd arguments passed directly to tool functions; this was already supported for other methods of setting the working directory

• Updates to wbttools and wbttoolparameters datasets

  • Fix for argument_name='k'

  • Remove several one and two character flag aliases from argument_name and replace with full name

• Add support for showing warning messages in regular interactive/verbose mode, thanks to @alenahav for reporting an issue (#75) with wbt_fd8_flow_accumulation()

• Functions that take multiple files are auto-quoted by default; thanks to François-Nicolas Robinne for reporting issue (@FNRobinne; #55) with wbt_mosaic()

• Error output is now more verbose, ensuring relevant tool output is displayed to user on error regardless of verbosity, platform, etc. Thanks to Jeffrey W. Rozelle for reporting issue (@jwilliamrozelle; #80) with getting error messages about unsupported raster types

whitebox 2.1.3

• Generated whitebox_tools commands no longer include flags for default arguments that are stored in settings.json unless specified by the user.

  • Updates to fix issues with permissions to write settings.json; thanks to Henrik (@hewag1975) for reporting problems on Shiny Server (#67)

• wbt_install() / install_whitebox() now removes the downloaded zip file on exit thanks to Christoph Stepper (@cstepper; #72)

• New default arguments for wbt_list_tools(), wbt_time_in_daylight(), wbt_shadow_image() thanks to Jens Wiesehahn (@wiesehahn; #70, #73)

CRAN Release 2.1.2

whitebox 2.1.2

• Fixes regression in checking "Demo" vignette on CRAN

CRAN Release 2.1.1

whitebox 2.1.1

• File path arguments to tools now automatically perform path expansion (converting ~ to your home directory with path.expand()). This also works on arguments that contain comma or semicolon delimited lists. (#62)

• Corrections to wbttoolparameters dataset (updated classification of input/output parameters)

• Fix for wbt_lidar_tin_gridding() exclude_cls argument

• Add wbt_compress_rasters() to set package option whitebox.compress_rasters

  • Updated how --compress_rasters parameter is passed via command line. Now the flag is added to all commands regardless of whether the value is TRUE or FALSE. This allows update of settings.json accordingly when --compress_rasters=FALSE. RE: jblindsay/whitebox-tools#233 (comment)

• Add wbt_max_procs() to set package option whitebox.max_procs

• All wbt_*() tool functions now take a command_only argument that is passed to wbt_run_tool(). When TRUE, the function returns the command that would be run by system() instead of running the tool.

CRAN Release 2.1.0

The following new Whitebox Tools functions are available in whitebox v2.1.0. See https://www.whiteboxgeo.com/whitebox-geospatial-news/ for details.

• wbt_accumulation_curvature()
• wbt_curvedness()
• wbt_dbscan()
• wbt_difference_curvature()
• wbt_gaussian_curvature()
• wbt_gaussian_scale_space()
• wbt_generalize_classified_raster()
• wbt_generalize_with_similarity()
• wbt_generating_function()
• wbt_geomorphons()
• wbt_horizontal_excess_curvature()
• wbt_knn_classification()
• wbt_knn_regression()
• wbt_lidar_shift()
• wbt_local_hypsometric_analysis()
• wbt_local_quadratic_regression()
• wbt_logistic_regression()
• wbt_max_upslope_elev_change()
• wbt_maximal_curvature()
• wbt_mean_curvature()
• wbt_minimal_curvature()
• wbt_random_forest_classification()
• wbt_random_forest_regression()
• wbt_ring_curvature()
• wbt_rotor()
• wbt_shape_index()
• wbt_slope_vs_aspect_plot()
• wbt_svm_classification()
• wbt_svm_regression()
• wbt_unsphericity()
• wbt_vertical_excess_curvature()

What's Changed

• whitebox v2.1.0 by @brownag in #57
• Added machine learning tools by @giswqs in #59
• CRAN Release 2.1.0 by @brownag in #60

Full Changelog: v2.0.0...v2.1.0