Skip to contents

Changelog

Source: NEWS.md

whitebox 2.4.3

CRAN release: 2025-10-20

  • Fix for CRAN check (#135)

    • GeoTIFF DEM sample data (extdata/DEM.tif) previously excluded, along with all other TIFF files, by .Rbuildignore is now explicitly included

    • Fix for behavior of sample_dem_data() destfile argument:

      • Errors thrown from invalid sources from new wbt_source() (introduced in v2.4.2) revealed an underlying issue with sample data assets. Invalid source errors are now intentionally captured and tested, and inclusion of the extdata file should ensure other parts of tests work as expected

      • When destfile unset and no local file present, sample_dem_data() no longer attempts to download and write to the user package library (which is read-only on CRAN)

      • destfile now intended for copying the sample dataset from package extdata folder, for workflows that need the sample data outside of the package library

  • sample_soils_data() now supports destfile (just like sample_dem_data())

whitebox 2.4.2

CRAN release: 2025-10-14

  • wbt_source(): now accepts tmpdir argument which defaults to tempdir() (not getwd() or wbt_wd()) that is used for storing the intermediate shapefiles needed for WhiteboxTools

    • Also, the pattern for temporary file names is now customizable via pattern argument

  • Bug fixes for wbt_source():

    • No longer writes temporary intermediate files to the working directory when passed a non-shapefile vector or non-GeoTIFF raster data source.

      • The temporary directory is used by default, unless new tmpdir argument is specified. This could be a breaking change if you were relying on the temporary files to be present in the WhiteboxTools working directory. Specify tmpdir in call to wbt_source() to make old behavior explicit.

    • Properly uses layer argument for data sources (e.g. GPKG) that may contain multiple vector layers or raster bands of interest (thanks to @mps9506 for reporting; #132)

whitebox 2.4.1

  • Rebuilt wbttools and wbttoolparameters with WhiteboxTools v2.4.0

whitebox 2.4.0

CRAN release: 2024-05-27

whitebox 2.3.4

CRAN release: 2023-11-18

  • 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

whitebox 2.3.1

CRAN release: 2023-06-07

whitebox 2.3.0

CRAN release: 2023-03-29

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.

whitebox 2.2.0

CRAN release: 2022-10-27

  • Updates for WhiteboxTools v2.2.0

  • 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

whitebox 2.1.5

CRAN release: 2022-07-11

  • 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

whitebox 2.1.4

CRAN release: 2022-05-15

  • 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 (https://github.com/opengeos/whiteboxR/issues/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; https://github.com/opengeos/whiteboxR/issues/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; https://github.com/opengeos/whiteboxR/issues/80) with getting error messages about unsupported raster types

whitebox 2.1.3

whitebox 2.1.2

CRAN release: 2022-03-21

  • Fixes regression in checking “Demo” vignette on CRAN

whitebox 2.1.1

CRAN release: 2022-03-15

whitebox 2.1.0

CRAN release: 2022-02-11

whitebox 2.0.0

CRAN release: 2021-09-10

Enhancements:

whitebox 1.5.1

  • Add package options for custom EXE path and verbosity

    • Changes behavior of wbt_init(); now only checks EXE path

  • Adds install_whitebox() to handle downloading and installing WhiteboxTools

New package options

  • wbt_init() can set any of the other options in the same call as the custom EXE path.

  • Use a system environment variable (R_WHITEBOX_EXE_PATH) or package option (whitebox.exe_path)

  • Verbosity controlled with (R_WHITEBOX_VERBOSE) or package option (whitebox.verbose)

  • Working directory controlled with (R_WHITEBOX_WD) or package option (whitebox.wd)

  • New “whitebox Demo” vignette

  • New data wbttools and wbttoolparameters data.frame built from WhiteboxTools v1.5.0 and wbt_tool_parameters() output for full tool library

    • See the “whitebox Tool Metadata” vignette

whitebox 1.5.0

whitebox 1.4.0

whitebox 1.3.1

whitebox 1.3.0

  • Update to WhiteboxTools v1.3.0

whitebox 1.1.0

  • Update to WhiteboxTools v1.1.0

whitebox 1.0.2

  • Update to WhiteboxTools v1.0.2

whitebox 1.0.1

  • Prep for v1.0.1

whitebox 0.5.0

  • Fix bugs for logical parameters

whitebox 0.3.0

whitebox 0.2.0

  • Change the way to download WBT binaries

whitebox 0.1.1

  • Update to use secure download mechanisms (https)

whitebox 0.1

  • Initial release