install_whitebox: Download and Install WhiteboxTools

View source: R/wbt.R

wbt_installR Documentation

Download and Install WhiteboxTools

Description

This function downloads the WhiteboxTools binary if needed. Pre-compiled binaries are only available for download for 64-bit Linux (Ubuntu 20.04), Windows and Mac OS (Intel) platforms. If you need WhiteboxTools for another platform follow the instructions here: https://github.com/jblindsay/whitebox-tools

Usage

wbt_install(pkg_dir = find.package("whitebox"), force = FALSE)

install_whitebox(pkg_dir = find.package("whitebox"), force = FALSE)

wbt_install_extension(
  extension = c("GeneralToolsetExtension", "AgricultureToolset",
    "DemAndSpatialHydrologyToolset", "LidarAndRemoteSensingToolset"),
  destdir = dirname(wbt_exe_path(shell_quote = FALSE))
)

Arguments

pkg_dir

default install path is to whitebox package "WBT" folder

force

logical. Default FALSE. Force install?

extension

Extension name

destdir

Directory to create /plugins/ directory for extracting extensions

Value

Prints out the location of the WhiteboxTools binary, if found. NULL otherwise.

Examples

## Not run: 
install_whitebox()

## End(Not run)

whitebox documentation built on Oct. 29, 2022, 1:10 a.m.