R Observatory: Metrics for whitebox version 2.4.3

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

whitebox

2.4.3

'WhiteboxTools' R Frontend

6packages depend

26.3Kdownloads / year

5.7%test coverage

13/13checks pass

Overview

About

Maintained by Andrew BrownFirst published 2019-02-0714 releasesCRAN page ↗GitHub ↗

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) doi:10.1016/j.cageo.2016.07.003.

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("whitebox", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("opengeos/whiteboxR")

Development version from opengeos/whiteboxR. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-whitebox

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-whitebox

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-whitebox

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 6.0 min · r-oldrel-windows-x86_64

Code health

Yes

Tests · ratio 0.04

5.7%

Coverage · measured lines

100%

Documentation · exports

0

Dependencies · direct

Check history

OK2026-08-04
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-06-08
12 OK · 0 NOTE · 0 WARNING · 0 ERROR · 1 FAILURE
ERROR2026-06-07
12 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 2,783 wordsVignettesYes · dynamicpkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

Examples that run: 21%
Documented parameters: 100%
Return-value docs: 100%
References docs: 0%

Downloads

26.3K

CRAN downloads in the past year

Rank #2,936 · ~72/day · ~2.2K/mo

Releases R versions

Daily download trend is not available in this view yet.

1.2K30 days

4.7K90 days

26.3K1 year

Compare downloads with other packages →

Also on335 r2u28 autocran58 c2d4u

Repository

GitHub ↗ opengeos/whiteboxr

186Stars

33Forks

5Open issues

0Open PRs

23Releases

417Commits

7Contributors

geospatialgisremote-sensinggeoprocessinghydrologygeomorphometryrrstudio

417 commits · Last activity 2025-10-21 · +0.5% stars, 30d

Stars over time

2025-08-10 · 1752026-08-18 · 186

Repository practices

Upstream repositoryBeta

8 development-tooling and community-health practices detected across 6 families in the upstream repository

Checks run against github.com/opengeos/whiteboxr on 2026-08-23.

Continuous integration (2)

GitHub ActionsAppVeyor

Reproducibility and dev environment (2)

data-raw/Dockerfile

CRAN release process (1)

cran-comments.md

Docs source (1)

README.Rmd

Show all practices

Automation and maintenance (1)

pre-commit

Coverage (1)

Codecov

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

6 external dependencies (excludes base and recommended)

Depends (1)

R >= 3.5

Imports (0)

none

LinkingTo (0)

none

Suggests (6)

knitr rmarkdown testthat terra sf raster

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

6direct

0indirect

CSHShydRology RPhosFate SAiVE floodflow transfR ursa

Code & Tests

Datasets

People & History

People (2)

Maintainer (1)

Andrew Brown

Author, Maintainer · added in 2.0.0

Authors (2)

Andrew Brown

Author, Maintainer · added in 2.0.0

Qiusheng Wu

Author

Package Timeline

14 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
2.4.3Latest
2025-10-20 · current release · diff ↗
2.4.2
2025-10-14 · diff ↗
R
R 4.5.0 released · 2025-04-11
2.4.0
2024-05-27 · diff ↗
R
R 4.4.0 released · 2024-04-24
2.3.4
2023-11-18 · diff ↗
2.3.1
2023-06-07 · diff ↗
R
R 4.3.0 released · 2023-04-21
2.3.0
2023-03-29 · diff ↗
2.2.0
2022-10-27 · diff ↗
2.1.5
2022-07-11 · diff ↗
2.1.4
2022-05-15 · diff ↗
R
R 4.2.0 released · 2022-04-22
2.1.2
2022-03-21 · diff ↗
2.1.1
2022-03-15 · diff ↗

Show 9 earlier events

2.1.0
2022-02-11 · diff ↗
2.0.0
2021-09-10 · diff ↗
unarchivedReturned to CRAN
2021-09-10
R
R 4.1.0 released · 2021-05-18
R
R 4.0.0 released · 2020-04-24
R
R 3.6.0 released · 2019-04-26
archivedRemoved from CRAN
2019-02-08
policy violation
0.1.0
2019-02-07
R
R 3.5.0 released · 2018-04-23

Package metadata

First published: 2019-02-07
Total releases: 14 / 7 yrs
License: MIT + file LICENSE OSI
Minimum R: ≥ 3.5
Bundled data: 78 KB / 2 files
Download size: 1.0 MB
Installed size: not tracked yet
With dependencies: not tracked yet

Appears in task views

Hydrological Data and Modeling Analysis of Spatial Data

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("whitebox")

Format

Brown, A., & Wu, Q. (2025). whitebox: 'WhiteboxTools' R Frontend (Version 2.4.3) [Computer software]. https://doi.org/10.32614/CRAN.package.whitebox

This is what citation() produces when a package has no citation file of its own. If it prints something else, use that.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for whitebox version 2.4.3 [Data set]. HJJB, LLC. Data release v2026-08-23. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-23, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →