mlr3spatiotempcv (version 1.0.1)

ResamplingSpCVEnv: (blockCV) "Environmental blocking" resampling

Description

(blockCV) "Environmental blocking" resampling

(blockCV) "Environmental blocking" resampling

mlr3spatiotempcv notes

The 'Description' and 'Details' fields are inherited from the respective upstream function.

For a list of available arguments, please see blockCV::envBlock.

Super class

mlr3::Resampling -> ResamplingSpCVEnv

Active bindings

iters

integer(1) Returns the number of resampling iterations, depending on the values stored in the param_set.

Methods

Public methods

• ResamplingSpCVEnv$new()

• ResamplingSpCVEnv$instantiate()

• ResamplingSpCVEnv$clone()

• mlr3::Resampling$format()

• mlr3::Resampling$help()

• mlr3::Resampling$print()

• mlr3::Resampling$test_set()

• mlr3::Resampling$train_set()

Method new()

Create an "Environmental Block" resampling instance.

For a list of available arguments, please see blockCV::envBlock.

Usage

ResamplingSpCVEnv$new(id = "spcv_env")

Arguments

id

character(1) Identifier for the resampling strategy.

Method instantiate()

Materializes fixed training and test splits for a given task.

Usage

ResamplingSpCVEnv$instantiate(task)

Arguments

task

Task A task to instantiate.

Method clone()

The objects of this class are cloneable with this method.

Usage

ResamplingSpCVEnv$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

References

Valavi R, Elith J, Lahoz-Monfort JJ, Guillera-Arroita G (2018). “blockCV: an R package for generating spatially or environmentally separated folds for k-fold cross-validation of species distribution models.” bioRxiv. 10.1101/357798.

Examples

# NOT RUN {
if (mlr3misc::require_namespaces(c("sf", "blockCV"), quietly = TRUE)) {
  library(mlr3)
  task = tsk("ecuador")

  # Instantiate Resampling
  rcv = rsmp("spcv_env", folds = 4)
  rcv$instantiate(task)

  # Individual sets:
  rcv$train_set(1)
  rcv$test_set(1)
  intersect(rcv$train_set(1), rcv$test_set(1))

  # Internal storage:
  rcv$instance
}
# }