mlr3spatiotempcv (version 1.0.1)

ResamplingRepeatedSpCVBlock: (blockCV) Repeated spatial block resampling

Description

(blockCV) Repeated spatial block resampling

(blockCV) Repeated spatial block resampling

mlr3spatiotempcv notes

By default blockCV::spatialBlock() does not allow the creation of multiple repetitions. mlr3spatiotempcv adds support for this when using the range argument for fold creation. When supplying a vector of length(repeats) for argument range, these different settings will be used to create folds which differ among the repetitions.

Multiple repetitions are not possible when using the "row & cols" approach because the created folds will always be the same.

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

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

Super class

mlr3::Resampling -> ResamplingRepeatedSpCVBlock

Public fields

blocks

sf | list of sf objects Polygons (sf objects) as returned by blockCV which grouped observations into partitions.

Active bindings

iters

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

Methods

Public methods

• ResamplingRepeatedSpCVBlock$new()

• ResamplingRepeatedSpCVBlock$folds()

• ResamplingRepeatedSpCVBlock$repeats()

• ResamplingRepeatedSpCVBlock$instantiate()

• ResamplingRepeatedSpCVBlock$clone()

• mlr3::Resampling$format()

• mlr3::Resampling$help()

• mlr3::Resampling$print()

• mlr3::Resampling$test_set()

• mlr3::Resampling$train_set()

Method new()

Create an "spatial block" repeated resampling instance.

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

Usage

ResamplingRepeatedSpCVBlock$new(id = "repeated_spcv_block")

Arguments

id

character(1) Identifier for the resampling strategy.

Method folds()

Translates iteration numbers to fold number.

Usage

ResamplingRepeatedSpCVBlock$folds(iters)

Arguments

iters

integer() Iteration number.

Method repeats()

Translates iteration numbers to repetition number.

Usage

ResamplingRepeatedSpCVBlock$repeats(iters)

Arguments

iters

integer() Iteration number.

Method instantiate()

Materializes fixed training and test splits for a given task.

Usage

ResamplingRepeatedSpCVBlock$instantiate(task)

Arguments

task

Task A task to instantiate.

Method clone()

The objects of this class are cloneable with this method.

Usage

ResamplingRepeatedSpCVBlock$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("diplodia")

  # Instantiate Resampling
  rrcv = rsmp("repeated_spcv_block",
    folds = 3, repeats = 2,
    range = c(5000L, 10000L))
  rrcv$instantiate(task)

  # Individual sets:
  rrcv$iters
  rrcv$folds(1:6)
  rrcv$repeats(1:6)

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

  # Internal storage:
  rrcv$instance # table
}
# }