mlr_coercions: Object Coercion

In mllg/mlr3: Machine Learning in R - Next Generation

Description

S3 generics and methods to coerce to (lists of) Task, Learner, Resampling, and Measure.

Usage

## S3 method for class 'character'
as_task(x, clone = FALSE)

## S3 method for class 'character'
as_tasks(x, clone = FALSE)

## S3 method for class 'character'
as_learner(x, clone = FALSE)

## S3 method for class 'character'
as_learners(x, clone = FALSE)

## S3 method for class 'character'
as_resampling(x, clone = FALSE)

## S3 method for class 'character'
as_resamplings(x, clone = FALSE)

## S3 method for class 'character'
as_measure(x, task_type = NULL, clone = FALSE)

## S3 method for class 'character'
as_measures(x, task_type = NULL, clone = FALSE)

as_task(x, clone = FALSE)

## S3 method for class 'Task'
as_task(x, clone = FALSE)

as_tasks(x, clone = FALSE)

## S3 method for class 'list'
as_tasks(x, clone = FALSE)

## S3 method for class 'Task'
as_tasks(x, clone = FALSE)

as_learner(x, clone = FALSE)

## S3 method for class 'Learner'
as_learner(x, clone = FALSE)

as_learners(x, clone = FALSE)

## S3 method for class 'list'
as_learners(x, clone = FALSE)

## S3 method for class 'Learner'
as_learners(x, clone = FALSE)

as_resampling(x, clone = FALSE)

## S3 method for class 'Resampling'
as_resampling(x, clone = FALSE)

as_resamplings(x, clone = FALSE)

## S3 method for class 'list'
as_resamplings(x, clone = FALSE)

## S3 method for class 'Resampling'
as_resamplings(x, clone = FALSE)

as_measure(x, task_type = NULL, clone = FALSE)

## S3 method for class 'NULL'
as_measure(x, task_type = NULL, clone = FALSE)

## S3 method for class 'Measure'
as_measure(x, task_type = NULL, clone = FALSE)

as_measures(x, task_type = NULL, clone = FALSE)

## S3 method for class 'NULL'
as_measures(x, task_type = NULL, clone = FALSE)

## S3 method for class 'list'
as_measures(x, task_type = NULL, clone = FALSE)

## S3 method for class 'Measure'
as_measures(x, task_type = NULL, clone = FALSE)

Arguments

x	:: any Object to coerce.
clone	:: logical(1) If TRUE, ensures that the returned object is not the same as the input x, e.g. by cloning it or constructing it from a mlr3misc::Dictionary.
task_type	:: character(1) Used if x is NULL to construct a default measure for the respective task type. The default measures are stored in mlr_reflections$default_measures.

Value

Coerced object. The default method will return the object as-is. Failed coercions have to be handled by on of the assertions in mlr_assertions.

Examples

# convert single measure to list of measures
measure = msr("classif.ce")
as_measures(measure)

mllg/mlr3 documentation built on Sept. 27, 2019, 9:38 a.m.