as_data_backend: Coerce to spatial DataBackend

In mlr3spatial: Support for Spatial Objects Within the 'mlr3' Ecosystem

Coerce to spatial DataBackend

Description

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.

Usage

## S3 method for class 'stars'
as_data_backend(data, primary_key = NULL, ...)

## S3 method for class 'SpatRaster'
as_data_backend(data, primary_key = NULL, ...)

## S3 method for class 'RasterBrick'
as_data_backend(data, primary_key = NULL, ...)

## S3 method for class 'RasterStack'
as_data_backend(data, primary_key = NULL, ...)

## S3 method for class 'sf'
as_data_backend(data, primary_key = NULL, keep_rownames = FALSE, ...)

Arguments

data	(terra::SpatRaster) The input terra::SpatRaster.
primary_key	(character(1) | integer()) Name of the primary key column, or integer vector of row ids.
...	(any) Not used.
keep_rownames	(logical(1) | character(1)) If TRUE or a single string, keeps the row names of data as a new column. The column is named like the provided string, defaulting to "..rownames" for keep_rownames == TRUE. Note that the created column will be used as a regular feature by the task unless you manually change the column role. Also see data.table::as.data.table().

Value

mlr3::DataBackend.

mlr3spatial documentation built on Aug. 12, 2025, 1:08 a.m.