feat!: switch to SpatRaster

.github/workflows/R-CMD-check-backwards.yml

@@ -28,8 +28,8 @@ jobs:
         run: |
           install.packages("remotes")
           remotes::install_cran(
-            c("checkmate", "raster", "Rcpp", "RcppArmadillo", "spatstat.geom", "yaml", "whitebox", "rcmdcheck"),
-            repos = "https://packagemanager.posit.co/cran/2023-03-15",
+            c("checkmate", "raster", "Rcpp", "RcppArmadillo", "terra", "yaml", "whitebox", "rcmdcheck"),
+            repos = "https://packagemanager.posit.co/cran/2023-10-31",
             type = "win.binary",
             dependencies = TRUE
           )

DESCRIPTION

@@ -28,8 +28,9 @@ Imports:
     methods,
     raster (>= 3.6.3),
     Rcpp,
-    spatstat.geom,
     stats,
+    terra,
+    tools,
     utils,
     yaml
 Suggests:
@@ -50,7 +51,6 @@ Collate:
     'RPhosFate.R'
     'RcppExports.R'
     'assertives.R'
-    'deprecated.R'
     'gettersSetters.R'
     'input.R'
     'interface.R'

NAMESPACE

@@ -13,6 +13,7 @@ export(erosionPrerequisites)
 export(firstRun)
 export(getLayer)
 export(getParameter)
+export(img2tif)
 export(saveState)
 export(setParameter)
 export(snapGauges)
@@ -41,16 +42,12 @@ exportMethods(transportPrerequisites)
 import(checkmate)
 import(methods)
 import(raster)
+import(terra)
 importFrom(Rcpp,sourceCpp)
 importFrom(graphics,abline)
 importFrom(graphics,clip)
 importFrom(graphics,par)
-importFrom(graphics,points)
-importFrom(spatstat.geom,as.owin)
-importFrom(spatstat.geom,as.ppp)
-importFrom(spatstat.geom,nncross)
 importFrom(stats,cor)
-importFrom(stats,median)
 importFrom(stats,optim)
 importFrom(stats,optimize)
 importFrom(stats,sd)

NEWS.md

@@ -1,17 +1,25 @@
 # RPhosFate v1.0.4.9000
 
+* Switched to utilising the `SpatRaster` class from the `terra` package instead of the `RasterLayer` class from the `raster` package. However, the transition from `raster` to `terra` encompasses only the core and not `DEMrelatedInput()` yet.
+* Added `is_ths` parameter: allows for specifying the number of threads to use for processing. 
+* Ceased support for _ERDAS IMAGINE_ (\*.img) raster files. `img2tif()` can be used to convert all _ERDAS IMAGINE_ raster files in a directory and its subdirectories into _GeoTIFF_ raster files.
+* Dropped backward compatibility to major version zero.
+* Removed `spatstat.geom` from imported packages list (utilised functionality is now also provided by `terra`).
+* Bumped minimum tested R version from 4.2.3 to 4.3.2 using the corresponding _Posit_ public package manager snapshot.
+* Major internal code improvements.
+
 # RPhosFate v1.0.4
 
 * The current `raster` package does not compress _GeoTIFF_ raster files any longer by default. This is probably due to the switch from `rgdal` to `terra` and has been fixed by generally using the _LZW_ algorithm.
 * Fixed warning "GDAL Message 6: driver GTiff does not support creation option COMPRESSED" curiously only occurring in the reference on GitHub Pages.
 * Removed `hydroGOF` from imported packages list (`maptools` is retiring and `hydroGOF` depends on it via `hydroTSM`). Thanks to Roger Bivand for raising this issue (#17).
-* Bumped minimum tested R version from 4.2.2 to 4.2.3 using the corresponding Posit Public Package Manager snapshot.
+* Bumped minimum tested R version from 4.2.2 to 4.2.3 using the corresponding _Posit_ public package manager snapshot.
 * Slightly improved documentation.
 
 # RPhosFate v1.0.3
 
 * Removed `rgdal` from suggested packages list and set minimum required version of the `raster` package to ≥ 3.6.3 (`rgdal` is retiring and `raster` ≥ 3.6.3 does not depend on it any longer). Thanks to Roger Bivand for raising this issue (#17).
-* Bumped minimum tested R version from 4.1.2 to 4.2.2 using the corresponding MRAN repository snapshot.
+* Bumped minimum tested R version from 4.1.2 to 4.2.2 using the corresponding _MRAN_ repository snapshot.
 * Slightly improved documentation.
 * Minor internal code improvements.
 
@@ -51,8 +59,8 @@
 # RPhosFate v0.10.0
 
 * `DEMrelatedInput()` function now calculates the slopes from the breached DEM (stream burning is undone beforehand).
-* Switched to utilising _GeoTIFF_ (\*.tif) instead of _Erdas Imagine_ (\*.img) raster files.
-* Added `cs_fex` argument to `DEMrelatedInput()` function: allows for using _Erdas Imagine_ raster files for backward compatibility.
+* Switched to utilising _GeoTIFF_ (\*.tif) instead of _ERDAS IMAGINE_ (\*.img) raster files.
+* Added `cs_fex` argument to `DEMrelatedInput()` function: allows for using _ERDAS IMAGINE_ raster files for backward compatibility.
 * Added `cs_dir` argument to `DEMrelatedInput()` function: allows for utilising an existing D8 flow directions raster using _ArcGIS_ codes.
 * Added `demoProject()` function providing training data.
 * Added examples to documentation.

R/GOFmetrics.R

@@ -20,7 +20,7 @@ kge <- function(mld, old) {
 }
 
 mdrae <- function(rae) {
-  MdRAE <- median(rae)
+  MdRAE <- stats::median(rae)
 
   if (qtest(MdRAE, "N1(,)")) {
     MdRAE