Skip to content

Commit

Permalink
whitebox 2.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
brownag committed Mar 21, 2022
1 parent fc98e87 commit ca55f6f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: whitebox
Type: Package
Title: 'WhiteboxTools' R Frontend
Version: 2.1.1
Version: 2.1.2
Description: 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>.
Authors@R: c(person("Qiusheng", "Wu", email = "[email protected]", role = c("aut")),
person("Andrew", "Brown", email = "[email protected]", role = c("ctb", "cre")))
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# whitebox 2.1.2

* Fixes regression in checking "Demo" vignette on CRAN

# 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. (https://github.com/giswqs/whiteboxR/issues/62)
Expand Down
16 changes: 8 additions & 8 deletions vignettes/demo.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,21 @@ vignette: >
```{r, include = FALSE}
knitr::opts_chunk$set(
eval = whitebox::check_whitebox_binary(),
echo = TRUE,
collapse = TRUE,
comment = "#>",
fig.width = 6,
fig.height = 6
)
```

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```{r, include=FALSE, echo=FALSE, eval=TRUE}
# setup so inline stats on version/tools show up
library(whitebox)
data("wbttoolparameters", package="whitebox")
```

```{r setup, include=FALSE}
# # sample code to check and install whitebox to a custom path
# if (!whitebox::check_whitebox_binary()) {
# wd <- tempdir()
Expand Down Expand Up @@ -501,17 +505,13 @@ wbt_version()

### `wbt_list_tools()`

```{r include=FALSE}
data("wbttoolparameters", package="whitebox")
```

Use `wbt_list_tools()` to list all available tools in WhiteboxTools. In version `r attr(wbttoolparameters, 'version')` there are over `r (length(whitebox::wbt_list_tools()) - 1)` tools! See all the available [toolboxes](https://www.whiteboxgeo.com/manual/wbt_book/available_tools/index.html) and [extensions](https://www.whiteboxgeo.com/whitebox-geospatial-extensions/).

```{r, eval=FALSE}
wbt_list_tools()
```

The full list can be an overwhelming amount of output, so you pass the `keyword` argument to search and filter.
The full list can be an overwhelming amount of output, so you pass the `keywords` argument to search and filter.

For example we list tools with keyword 'flowaccumulation' in tool name or description.

Expand Down Expand Up @@ -545,7 +545,7 @@ wbt_toolbox(tool_name = "aspect")

Print the full list by not specifying `tool_name`

```{r, eval=FALSE}
```{r}
wbt_toolbox()
```

Expand Down

0 comments on commit ca55f6f

Please sign in to comment.