release: 0.6.0 (#98)

be-marc · web-flow · commit f7571ec55fcc · 2025-07-18T12:51:49.000+02:00
* fix: throw an error when X and Y columns are present in an sf object

* ...

* release: 0.6.0

* ...

* ...

* ...

* ...

* ...

* ...
diff --git a/.github/workflows/dev-cmd-check.yml b/.github/workflows/dev-cmd-check.yml
@@ -1,7 +1,13 @@
-# dev cmd check workflow of the mlr3 ecosystem v0.1.0
+# dev cmd check workflow of the mlr3 ecosystem v0.4.0
 # https://github.com/mlr-org/actions
 on:
   workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled'
+        required: false
+        default: false
   push:
     branches:
       - main
@@ -25,11 +31,12 @@ jobs:
       matrix:
         config:
           - {os: ubuntu-latest, r: 'release', dev-package: 'mlr-org/mlr3'}
-          - {os: ubuntu-latest, r: 'release', dev-package: "mlr-org/paradox', 'mlr-org/mlr3learners"}
 
     steps:
       - uses: actions/checkout@v3
 
+      - uses: r-lib/actions/setup-pandoc@v2
+
       - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
@@ -38,9 +45,17 @@ jobs:
         with:
           extra-packages: any::rcmdcheck
           needs: check
+          error-on: '"note"'
 
       - name: Install dev versions
-        run: pak::pkg_install(c('${{ matrix.config.dev-package }}'))
+        run: pak::pkg_install('${{ matrix.config.dev-package }}')
         shell: Rscript {0}
 
+      - uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+        with:
+          limit-access-to-actor: true
+
       - uses: r-lib/actions/check-r-package@v2
+        with:
+          args: 'c("--no-manual", "--as-cran")'
diff --git a/.github/workflows/r-cmd-check.yml b/.github/workflows/r-cmd-check.yml
@@ -1,7 +1,13 @@
-# r cmd check workflow of the mlr3 ecosystem v0.1.0
+# r cmd check workflow of the mlr3 ecosystem v0.4.0
 # https://github.com/mlr-org/actions
 on:
   workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled'
+        required: false
+        default: false
   push:
     branches:
       - main
@@ -26,11 +32,12 @@ jobs:
         config:
           - {os: ubuntu-latest,   r: 'devel'}
           - {os: ubuntu-latest,   r: 'release'}
-          - {os: ubuntu-latest, r: 'release', dev-package: 'mlr-org/mlr3@weights_reworked'}
 
     steps:
       - uses: actions/checkout@v3
 
+      - uses: r-lib/actions/setup-pandoc@v2
+
       - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
@@ -39,5 +46,13 @@ jobs:
         with:
           extra-packages: any::rcmdcheck
           needs: check
+          error-on: '"note"'
+
+      - uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+        with:
+          limit-access-to-actor: true
 
       - uses: r-lib/actions/check-r-package@v2
+        with:
+          args: 'c("--no-manual", "--as-cran")'
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: mlr3spatial
 Title: Support for Spatial Objects Within the 'mlr3' Ecosystem
-Version: 0.5.0.9000
-Date: 2024-03-09
+Version: 0.6.0
+Date: 2025-07-18
 Authors@R:
     c(
      person("Marc", "Becker", , "marcbecker@posteo.de", role = c("aut", "cre"),
diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# mlr3spatial (development version)
+# mlr3spatial 0.6.0
 
 * fix: Throw an error when `X` and `Y` columns are present in an sf object
 
diff --git a/R/DataBackendRaster.R b/R/DataBackendRaster.R
@@ -244,7 +244,7 @@ DataBackendRaster = R6Class("DataBackendRaster",
 #' @title Coerce to spatial DataBackend
 #'
 #' @description
-#' Wraps a [DataBackend] around spatial objects.
+#' Wraps a [mlr3::DataBackend] around spatial objects.
 #' Currently these S3 methods are only alternative ways for writing `DataBackendRaster$new()`.
 #' They do not support coercing from other backends yet.
 #'
@@ -253,7 +253,7 @@ DataBackendRaster = R6Class("DataBackendRaster",
 #' @param ... (`any`)\cr
 #'   Not used.
 #'
-#' @return [DataBackend].
+#' @return [mlr3::DataBackend].
 #' @rdname as_data_backend
 #'
 #' @exportS3Method
diff --git a/R/TaskClassifST.R b/R/TaskClassifST.R
@@ -1,7 +1,7 @@
 #' @title Spatiotemporal Classification Task
 #'
 #' @description
-#' This task specializes [TaskClassif] for spatiotemporal classification problems.
+#' This task specializes [mlr3::TaskClassif] for spatiotemporal classification problems.
 #'
 #' A spatial example task is available via `tsk("ecuador")`.
 #'
@@ -49,7 +49,7 @@ TaskClassifST = R6::R6Class("TaskClassifST",
     #' @description
     #' Returns coordinates of observations.
     #'
-    #' @param row_ids (`integer()`)\cr
+    #' @param row_ids (`integer()`)
     #'   Vector of rows indices as subset of `task$row_ids`.
     #'
     #' @return [data.table::data.table()]
diff --git a/R/TaskRegrST.R b/R/TaskRegrST.R
@@ -1,7 +1,7 @@
 #' @title Spatiotemporal Regression Task
 #'
 #' @description
-#' This task specializes [TaskRegr] for spatiotemporal regression problems.
+#' This task specializes [mlr3::TaskRegr] for spatiotemporal regression problems.
 #'
 #' A spatial example task is available via `tsk("cookfarm_mlr3")`.
 #'
diff --git a/R/as_task_classif_st.R b/R/as_task_classif_st.R
@@ -5,9 +5,9 @@
 #' This is a S3 generic, specialized for at least the following objects:
 #'
 #' 1. [TaskClassifST]: Ensure the identity.
-#' 2. [data.frame()] and [DataBackend]: Provides an alternative to the constructor of [TaskClassifST].
+#' 2. [data.frame()] and [mlr3::DataBackend]: Provides an alternative to the constructor of [TaskClassifST].
 #' 3. [sf::sf]: Extracts spatial meta data before construction.
-#' 4. [TaskRegr]: Calls [convert_task()].
+#' 4. [mlr3::TaskRegr]: Calls [mlr3::convert_task()].
 #'
 #' @inheritParams mlr3::as_task_classif
 #' @template param_coords_as_features
diff --git a/R/as_task_regr_st.R b/R/as_task_regr_st.R
@@ -5,9 +5,9 @@
 #' This is a S3 generic, specialized for at least the following objects:
 #'
 #' 1. [TaskRegrST]: Ensure the identity.
-#' 2. [data.frame()] and [DataBackend]: Provides an alternative to the constructor of [TaskRegrST].
+#' 2. [data.frame()] and [mlr3::DataBackend]: Provides an alternative to the constructor of [TaskRegrST].
 #' 3. [sf::sf]: Extracts spatial meta data before construction.
-#' 4. [TaskClassif]: Calls [convert_task()].
+#' 4. [mlr3::TaskClassif]: Calls [mlr3::convert_task()].
 #'
 #' @inheritParams mlr3::as_task_regr
 #' @template param_coords_as_features
diff --git a/R/predict_spatial.R b/R/predict_spatial.R
@@ -5,7 +5,7 @@
 #'
 #' @param newdata ([terra::SpatRaster] | `stars::stars` | [sf::sf] | `raster::RasterStack` | `raster::RasterBrick`).
 #'   New data to predict on. All spatial data formats convertible by `as_data_backend()` are supported e.g. [terra::SpatRaster] or [sf::sf].
-#' @param learner ([Learner]).
+#' @param learner ([mlr3::Learner]).
 #'   Learner with trained model.
 #' @template param-chunksize
 #' @param format (`character(1)`)\cr
diff --git a/README.Rmd b/README.Rmd
@@ -25,7 +25,6 @@ Package website: [release](https://mlr3spatial.mlr-org.com/) | [dev](https://mlr
 <!-- badges: start -->
 [![r-cmd-check](https://github.com/mlr-org/mlr3spatial/actions/workflows/r-cmd-check.yml/badge.svg)](https://github.com/mlr-org/mlr3spatial/actions/workflows/r-cmd-check.yml)
 [![CRAN status](https://www.r-pkg.org/badges/version/mlr3spatial)](https://CRAN.R-project.org/package=mlr3spatial)
-[![StackOverflow](https://img.shields.io/badge/stackoverflow-mlr3-orange.svg)](https://stackoverflow.com/questions/tagged/mlr3)
 [![Mattermost](https://img.shields.io/badge/chat-mattermost-orange.svg)](https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/)
 <!-- badges: end -->
 
diff --git a/README.md b/README.md
@@ -9,7 +9,6 @@ Package website: [release](https://mlr3spatial.mlr-org.com/) \|
 [![r-cmd-check](https://github.com/mlr-org/mlr3spatial/actions/workflows/r-cmd-check.yml/badge.svg)](https://github.com/mlr-org/mlr3spatial/actions/workflows/r-cmd-check.yml)
 [![CRAN
 status](https://www.r-pkg.org/badges/version/mlr3spatial)](https://CRAN.R-project.org/package=mlr3spatial)
-[![StackOverflow](https://img.shields.io/badge/stackoverflow-mlr3-orange.svg)](https://stackoverflow.com/questions/tagged/mlr3)
 [![Mattermost](https://img.shields.io/badge/chat-mattermost-orange.svg)](https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/)
 <!-- badges: end -->
 
@@ -30,17 +29,17 @@ for spatiotemporal resampling within mlr3.
 There are sections about spatial data in the
 [mlr3book](https://mlr3book.mlr-org.com).
 
--   Learn how to
-    [predict](https://mlr3book.mlr-org.com/chapters/chapter13/beyond_regression_and_classification.html#sec-spatial-prediction)
-    a spatial raster image.
--   Estimate the performance of a model with [spatial
-    cross-validation](https://mlr3book.mlr-org.com/chapters/chapter13/beyond_regression_and_classification.html#sec-spatiotemporal).
+- Learn how to
+  [predict](https://mlr3book.mlr-org.com/chapters/chapter13/beyond_regression_and_classification.html#sec-spatial-prediction)
+  a spatial raster image.
+- Estimate the performance of a model with [spatial
+  cross-validation](https://mlr3book.mlr-org.com/chapters/chapter13/beyond_regression_and_classification.html#sec-spatiotemporal).
 
 The gallery features articles about spatial data in the mlr3 ecosystem.
 
--   Learn the basics with a [land cover
-    classification](https://mlr-org.com/gallery/technical/2023-02-27-land-cover-classification/)
-    of the city of Leipzig.
+- Learn the basics with a [land cover
+  classification](https://mlr-org.com/gallery/technical/2023-02-27-land-cover-classification/)
+  of the city of Leipzig.
 
 ## Installation
 
@@ -87,11 +86,12 @@ task = as_task_classif_st(leipzig, target = "land_cover")
 task
 ```
 
-    ## <TaskClassifST:leipzig> (97 x 9)
-    ## * Target: land_cover
-    ## * Properties: multiclass
-    ## * Features (8):
-    ##   - dbl (8): b02, b03, b04, b06, b07, b08, b11, ndvi
+    ## 
+    ## ── <TaskClassifST> (97x9) ──────────────────────────────────────────────────────────────────────────
+    ## • Target: land_cover
+    ## • Properties: multiclass
+    ## • Features (8):
+    ##   • dbl (8): b02, b03, b04, b06, b07, b08, b11, ndvi
     ## * Coordinates:
     ##            X       Y
     ##  1: 732480.1 5693957
@@ -125,6 +125,9 @@ to the `predict_spatial()` function.
 land_cover = predict_spatial(leipzig_raster, learner)
 ```
 
+    ## Warning in warn_deprecated("DataBackend$data_formats"): DataBackend$data_formats is deprecated and
+    ## will be removed in the future.
+
 <img src="man/figures/land_cover.png" />
 
 ## FAQ
diff --git a/man-roxygen/param_backend.R b/man-roxygen/param_backend.R
@@ -1,3 +1,3 @@
-#' @param backend ([DataBackend])\cr
-#'   Either a [DataBackend], or any object which is convertible to a [DataBackend] with `as_data_backend()`.
-#'   E.g., am `sf` will be converted to a [DataBackendDataTable].
+#' @param backend ([mlr3::DataBackend])\cr
+#'   Either a [mlr3::DataBackend], or any object which is convertible to a [mlr3::DataBackend] with `mlr3::as_data_backend()`.
+#'   E.g., am `sf` will be converted to a [mlr3::DataBackendDataTable].
diff --git a/man-roxygen/param_extra_args.R b/man-roxygen/param_extra_args.R
@@ -1,2 +1,2 @@
 #' @param extra_args (named `list()`)\cr
-#'   Named list of constructor arguments, required for converting task types via [convert_task()].
+#'   Named list of constructor arguments, required for converting task types via [mlr3::convert_task()].
diff --git a/man/TaskClassifST.Rd b/man/TaskClassifST.Rd
diff --git a/man/TaskRegrST.Rd b/man/TaskRegrST.Rd
diff --git a/man/as_data_backend.Rd b/man/as_data_backend.Rd
diff --git a/man/as_task_classif_st.Rd b/man/as_task_classif_st.Rd
diff --git a/man/as_task_regr_st.Rd b/man/as_task_regr_st.Rd
diff --git a/man/mlr3spatial-package.Rd b/man/mlr3spatial-package.Rd
diff --git a/man/predict_spatial.Rd b/man/predict_spatial.Rd

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# mlr3spatial (development version)`
	`1`	`+# mlr3spatial 0.6.0`
`2`	`2`
`3`	`3`	* fix: Throw an error when `X` and `Y` columns are present in an sf object
`4`	`4`