TaskRegrST: Create a Spatiotemporal Regression Task

In mlr-org/mlr3spatiotempcv: Spatiotemporal Resampling Methods for 'mlr3'

Create a Spatiotemporal Regression Task

Description

This task specializes Task and TaskSupervised for spatiotemporal classification problems.

A spatial example task is available via tsk("ecuador"), a spatiotemporal one via tsk("cookfarm_mlr3").

The coordinate reference system passed during initialization must match the one which was used during data creation, otherwise offsets of multiple meters may occur. By default, coordinates are not used as features. This can be changed by setting coords_as_features = TRUE.

Super classes

mlr3::Task -> mlr3::TaskSupervised -> mlr3::TaskRegr -> TaskRegrST

Active bindings

crs

(character(1))
Returns coordinate reference system of task.

coordinate_names

(character())
Coordinate names.

coords_as_features

(logical(1))
If TRUE, coordinates are used as features. This is a shortcut for task$set_col_roles(c("x", "y"), role = "feature") with the assumption that the coordinates in the data are named "x" and "y".

Methods

Public methods

• TaskRegrST$new()

• TaskRegrST$coordinates()

• TaskRegrST$print()

• TaskRegrST$clone()

Inherited methods

• mlr3::Task$add_strata()
• mlr3::Task$cbind()
• mlr3::Task$data()
• mlr3::Task$droplevels()
• mlr3::Task$filter()
• mlr3::Task$format()
• mlr3::Task$formula()
• mlr3::Task$head()
• mlr3::Task$help()
• mlr3::Task$levels()
• mlr3::Task$missings()
• mlr3::Task$rbind()
• mlr3::Task$rename()
• mlr3::Task$select()
• mlr3::Task$set_col_roles()
• mlr3::Task$set_levels()
• mlr3::Task$set_row_roles()
• mlr3::TaskRegr$truth()

---

Method new()

Create a new spatiotemporal resampling Task Returns coordinates of observations.

Usage

TaskRegrST$new(
  id,
  backend,
  target,
  label = NA_character_,
  coordinate_names,
  crs = NA_character_,
  coords_as_features = FALSE,
  extra_args = list()
)

Arguments

id

(character(1))
Identifier for the new instance.

backend

(DataBackend)
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.

target

(character(1))
Name of the target column.

label

(character(1))
Label for the new instance. Shown in as.data.table(mlr_tasks).

coordinate_names

(character(1))
The column names of the coordinates in the data.

crs

(character(1))
Coordinate reference system. WKT2 or EPSG string.

coords_as_features

(logical(1))
If TRUE, coordinates are used as features. This is a shortcut for task$set_col_roles(c("x", "y"), role = "feature") with the assumption that the coordinates in the data are named "x" and "y".

extra_args

(named list())
Named list of constructor arguments, required for converting task types via convert_task().

---

Method coordinates()

Usage

TaskRegrST$coordinates(row_ids = NULL)

Arguments

row_ids

(integer())
Vector of rows indices as subset of task$row_ids.

Returns

data.table::data.table()

---

Method print()

Print the task.

Usage

TaskRegrST$print(...)

Arguments

...

Arguments passed to the ⁠$print()⁠ method of the superclass.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

TaskRegrST$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other Task: TaskClassifST, mlr_tasks_cookfarm_mlr3, mlr_tasks_diplodia, mlr_tasks_ecuador

mlr-org/mlr3spatiotempcv documentation built on April 18, 2024, 12:24 a.m.