mlr3 (version 0.1.2)

mlr_assertions: Assertion for mlr3 Objects

Description

Functions intended to be used in packages extending mlr3. All functions assert on the respective class, and optionally additional properties. If an assertion fails, an exception is raised. Otherwise, the input object is returned invisibly.

Usage

assert_backend(b, .var.name = checkmate::vname(b), add = NULL)
assert_task(task, task_type = NULL, feature_types = NULL,
  task_properties = NULL, .var.name = checkmate::vname(task),
  add = NULL)
assert_tasks(tasks, task_type = NULL, feature_types = NULL,
  task_properties = NULL, .var.name = checkmate::vname(tasks),
  add = NULL)
assert_learner(learner, task = NULL, properties = character(),
  .var.name = checkmate::vname(learner), add = NULL)
assert_learners(learners, task = NULL, properties = character(),
  .var.name = checkmate::vname(learners), add = NULL)
assert_measure(measure, task = NULL, learner = NULL,
  .var.name = checkmate::vname(measure), add = NULL)
assert_measures(measures, task = NULL, learner = NULL,
  .var.name = checkmate::vname(measures), add = NULL)
assert_resampling(resampling, instantiated = NULL,
  .var.name = checkmate::vname(resampling), add = NULL)
assert_resamplings(resamplings, instantiated = NULL,
  .var.name = checkmate::vname(resamplings), add = NULL)
assert_prediction(prediction, .var.name = checkmate::vname(prediction),
  add = NULL)
assert_resample_result(rr, .var.name = checkmate::vname(rr),
  add = NULL)
assert_benchmark_result(bmr, .var.name = checkmate::vname(bmr),
  add = NULL)
assert_row_ids(row_ids, type = NULL, .var.name = vname(row_ids))

Arguments

b

:: DataBackend.

task

:: Task.

feature_types

:: character() Set of allowed feature types.

task_properties

:: character() Set of required task properties.

tasks

:: list of Task.

learner

:: Learner.

learners

:: list of Learner.

measure

:: Measure.

measures

:: list of Measure.

resampling

:: Resampling.

resamplings

:: list of Resampling.

prediction

:: Prediction.

bmr

:: BenchmarkResult.

row_ids

:: vector().

resample_result

:: ResampleResult.