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

whitebox v2.0.0

whitebox 2.0.0 was published on CRAN on 2021/09/10

Commit tagged is "as submitted" to CRAN on 2021/09/06. New release will be created to cover anything that comes up from pending human review.

whitebox 2.0.0

• Update to WhiteboxTools v2.0.0
  • This is a major release update to the WhiteboxTools backend. See https://github.com/jblindsay/whitebox-tools/releases/tag/v2.0.0 for more details

install_whitebox()

• Adds install_whitebox() to handle downloading and installing WhiteboxTools
• Improvements to downloading process on multiple platforms / error messages
• whitebox::install_whitebox() will call wbt_init() on the exe_path after unpacking to target directory

New package options

• Add package options for custom EXE path, verbosity and working directory
  • Changes behavior of wbt_init(); now wbt_init() sets/checks EXE path or other options
  • wbt_options() sets/returns current option values

1. Use a system environment variable (R_WHITEBOX_EXE_PATH) or package option (whitebox.exe_path)
   • Get / set with wbt_init().
2. Verbosity controlled with (R_WHITEBOX_VERBOSE) or package option (whitebox.verbose)
   • Get / set with wbt_verbose()
3. Working directory controlled with (R_WHITEBOX_WD) or package option (whitebox.wd)
   • Get / set with wbt_wd(); for unsetting working directories (to current R working directory, dropping --wd flag) use wbt_wd("")

New vignettes

• "whitebox Demo"
• "whitebox Tool Metadata"
  • New data objects wbttools and wbttoolparameters data.frame built from WhiteboxTools v2.0.0
  • Use data(wbttools) or data(wbttoolparameters)

Path expansion

• wbt_init() exe_path, wbt_wd() wd, and install_whitebox() pkg_dir paths can be specified with shorthand ~ for home directory, which is expanded with path.expand()

Debugging tools

• Use the command_only=TRUE argument to wbt_run_tool() to get system commands without running them to inspect or save for later
• whitebox:::wbt_rust_backtrace() - [not currently exported] toggle RUST_BACKTRACE system environment variable settings

wbt_*() tool internal changes

• Functions no longer use match.call() internally to determine tool_name so automated methods for calling tools (that do not have a parseable tool_name in the call) now work as expected (#45)

---

Changelog includes "pre-released" changes from v1.5.1

v1.5.0

See https://github.com/jblindsay/whitebox-tools/releases/tag/1.5.0 for more info.

v1.4.0

Dr. John Lindsay has updated WhiteboxTools to v1.4.0. More information about this version can be found at https://github.com/jblindsay/whitebox-tools/releases/tag/1.4.0. I am updating the WhiteboxTools R frontend to v1.4.0.

See below the updates from Dr. John Lindsay:

This release adds some new tools and several bug fixes. Of the new tools, we are most excited about the addition of the TimeInDaylight tool, which estimates the proportion of daytime that each cell in a digital surface model (DSM) is in an exposed area. This is a very powerful method of performing a basic solar radiation modelling workflow. The new LidarDigitalSurfaceModel tool can be used to create DSMs for input to the TimeInDaylight tool. In addition to these updates, the User Manual has also been updated in numerous places with enhanced documentation. As always, if you wish to compile from source code, be sure to update to the most recent version of Rust beforehand using rustup update stable. Pre-compiled binaries are available for Windows (win), MacOS (Darwin), and Linux on Github and from the WhiteboxTools homepage. Please report any bugs that you encounter by creating an issue on the WhiteboxTools Github site.

• Added the TimeInDaylight model tool for modelling the proportion of daytime that a location is not in shadow.
• Added the MapOffTerrainObjects tool.
• Added the FilterRasterFeaturesByArea tool.
• Added the LidarDigitalSurfaceModel tool.
• The D8 and FD8 flow pointer tools now output byte rasters.
• The Isobasins tool now optionally outputs an upstream/downstream connections table.
• The HorizonAngle tool has had significant performance improvements.
• Improvements to the RemoveOffTerrainObjects tool's performance.
• The Resample tool has been modified so that it does not require a 'destination' raster. Instead,
• it will create a new output raster either based on a user-specified target cell resolution or
• an optional base raster, much like the vector-to-raster conversion tools.
• Tools that input a z_factor conversion no longer override user input with geographic coordinates
• (see issue #113).
• The StreamLinkIdentifier tool now outputs a 32-bit integer format, increasing the maximum allowable
• number of streams (see issue #110).
• Fixed a bug with cubic-convolution and bilinear resampling in the Mosaic tool (see issue #109).

v1.3.1

Dr. John Lindsay has updated WhiteboxTools to v1.3.1. More information about this version can be found at https://github.com/jblindsay/whitebox-tools/releases/tag/v1.3.1. I am updating the WhiteboxTools R frontend to v1.3.1.

This release adds a few new tools, including two options for creating more advanced hillshade images from DEMs, and better raster file support. This includes critical fixes for the WBT GeoTIFF reader/writer and added support for reading BIL files.

• Added the HypsometricallyTintedHillshade tool to create hypsometric tinted hillshades.
• Added the MultidirectionalHillshade tool.
• Added the ability to read/write in the Esri BIL raster format.
• Added the LidarRooftopAnalysis tool.
• The MultiPartToSinglePart tool now handles MultiPoint vectors.
• Fixed a bug with the VoronoiDiagram to better handle MultiPoint vectors.
• Fixed an issue with writing compressed RGB GeoTIFFs.
• Fixed an issue reading LZW compressed GeoTIFFs.

v1.3.0

Update to WhiteboxTools v1.3.0

v1.1.0

Update to WhiteboxTools v1.1.0

v1.0.2

Update to WhiteboxTools v1.0.2

v1.0.1

Prep for v1.0.1