Merge pull request #9 from brownag/v031

rgeomorphon v0.3.1

Author: brownag

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: rgeomorphon
 Type: Package
 Title: A Lightweight Implementation of the Geomorphon Algorithm
-Version: 0.3.0
+Version: 0.3.1
 Authors@R: person(given = "Andrew", family = "Brown", role = c("aut", "cre"), email = "brown.andrewg@gmail.com", comment = c(ORCID="0000-0002-4565-533X"))
 Maintainer: Andrew Brown <brown.andrewg@gmail.com>
 Description: A lightweight implementation of the geomorphon terrain
@@ -23,7 +23,7 @@ Enhances:
     parallel
 Encoding: UTF-8
 Language: en-US
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 Roxygen: list(markdown = TRUE)
 URL: https://github.com/brownag/rgeomorphon/, https://humus.rocks/rgeomorphon/
 BugReports: https://github.com/brownag/rgeomorphon/issues

R/geomorphon.R

@@ -837,10 +837,10 @@ geomorphon_theme <- function(x, forms = "forms10") {
 #' output tile, ensuring seamless results when the tiles are later merged.
 #'
 #' @param x A `SpatRasterCollection` containing the buffered input tiles,
-#'   typically from `geomorphons_create_tiles()`.
+#'   typically from `.geomorphons_create_tiles()`.
 #' @param y A `SpatVector` of polygons defining the original, unbuffered extents
 #'   of each tile. This is used for cropping the results. This is typically the
-#'   output from `geomorphons_tile_extents()`.
+#'   output from `.geomorphons_tile_extents()`.
 #' @param FUN The geomorphon function to apply to each tile (e.g.,
 #'   [geomorphons()]).
 #' @param cell_buffer Integer. The number of cells to add as a buffer around
@@ -929,7 +929,7 @@ geomorphon_theme <- function(x, forms = "forms10") {
 #' source DEM to ensure a perfect match.
 #'
 #' @param x `SpatRasterCollection` of the final result tiles, typically from
-#'   [geomorphons_process_tiles()].
+#'   `.geomorphons_process_tiles()`.
 #' @param y `SpatExtent` object from the original, full DEM. Used to ensure
 #'   the final output has the exact same extent. Default `NULL` uses full extent
 #'   of `x`.

man/forms_matrix.Rd

@@ -147,9 +147,9 @@ We can also pass the `nchunk` argument directly to `geomorphons()` to bypass the
 Now that `geomorphons()` will use a tiled approach, we can set up our parallel plan and execute the calculation.
 
 ```{r}
-# Set up a multisession future plan with 4 workers
-# This creates 4 background R sessions to do the work
-future::plan(multisession, workers = 4)
+# Set up a multisession future plan with 2 workers
+# This creates 2 background R sessions to do the work
+future::plan(multisession, workers = 2)
 ```
 
 Use the LAPPLY.FUN argument to pass `future.apply::future_lapply`. This tells `geomorphons()` to use the future backend for processing tiles
@@ -195,7 +195,7 @@ For example:
     ```{r}
     # Example using the base R parallel package
     library(parallel)
-    cl <- makeCluster(4)
+    cl <- makeCluster(2)
 
     g_forms_par <- geomorphons(
         dem,