Internal object to store results in list of data.tables, arranged in a star schema. It is advised to not directly work on this data structure as it may be changed in the future without further warnings.

The main motivation of this data structure is the necessity to avoid storing duplicated R6 objects. While this is usually no problem in a single R session, serialization via serialize() (which is used in save()/saveRDS() or during parallelization) leads to objects with unreasonable memory requirements.

## Public fields

data

(list())
List of data.tables(), arranged in a star schema. Do not operate directly on this list.

## Active bindings

task_type

(character(1))
Returns the task type of stored objects, e.g. "classif" or "regr". Returns NULL if the ResultData is empty.

## Methods

### Method new()

Creates a new instance of this R6 class. An alternative construction method is provided by as_result_data().

#### Arguments

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

#### Returns

character().

### Method iterations()

Returns the number of recorded iterations / experiments.

#### Arguments

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

#### Returns

data.table() with columns "task_hash" (character()) and "task" (Task).

### Method learners()

Returns a table of included Learners.

#### Arguments

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

#### Returns

data.table() with columns "resampling_hash" (character()) and "resampling" (Resampling).

### Method predictions()

Returns a list of Prediction objects.

#### Arguments

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

predict_sets

(character())
Prediction sets to operate on, used in aggregate() to extract the matching predict_sets from the ResampleResult. Multiple predict sets are calculated by the respective Learner during resample()/benchmark(). Must be a non-empty subset of {"train", "test", "validation"}. If multiple sets are provided, these are first combined to a single prediction object. Default is "test".

predict_sets

(character())
Prediction sets to operate on, used in aggregate() to extract the matching predict_sets from the ResampleResult. Multiple predict sets are calculated by the respective Learner during resample()/benchmark(). Must be a non-empty subset of {"train", "test", "validation"}. If multiple sets are provided, these are first combined to a single prediction object. Default is "test".

predict_sets

(character())
Prediction sets to operate on, used in aggregate() to extract the matching predict_sets from the ResampleResult. Multiple predict sets are calculated by the respective Learner during resample()/benchmark(). Must be a non-empty subset of {"train", "test", "validation"}. If multiple sets are provided, these are first combined to a single prediction object. Default is "test".

### Method combine()

Combines multiple ResultData objects, modifying self in-place.

#### Returns

Modified self (invisibly).

### Method discard()

Shrinks the object by discarding parts of the stored data.

ResultData$discard(backends = FALSE, models = FALSE) #### Arguments backends (logical(1)) If TRUE, the DataBackend is removed from all stored Tasks. models (logical(1)) If TRUE, the stored model is removed from all Learners. #### Returns Modified self (invisibly). ### Method as_data_table() Combines internal tables into a single flat data.table(). #### Usage ResultData$as_data_table(
view = NULL,
reassemble_learners = TRUE,
convert_predictions = TRUE,
predict_sets = "test"
)

#### Arguments

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

view

character(1)
Single uhash to restrict the results to.

reassemble_learners

(logical(1))

convert_predictions

(logical(1))
Convert PredictionData to Prediction?

predict_sets

(character())
Prediction sets to operate on, used in aggregate() to extract the matching predict_sets from the ResampleResult. Multiple predict sets are calculated by the respective Learner during resample()/benchmark(). Must be a non-empty subset of {"train", "test", "validation"}. If multiple sets are provided, these are first combined to a single prediction object. Default is "test".

predict_sets

(character())
Prediction sets to operate on, used in aggregate() to extract the matching predict_sets from the ResampleResult. Multiple predict sets are calculated by the respective Learner during resample()/benchmark(). Must be a non-empty subset of {"train", "test", "validation"}. If multiple sets are provided, these are first combined to a single prediction object. Default is "test".

predict_sets

(character())
Prediction sets to operate on, used in aggregate() to extract the matching predict_sets from the ResampleResult. Multiple predict sets are calculated by the respective Learner during resample()/benchmark(). Must be a non-empty subset of {"train", "test", "validation"}. If multiple sets are provided, these are first combined to a single prediction object. Default is "test".

### Method logs()

Get a table of recorded learner logs.

#### Arguments

deep

Whether to make a deep clone.

## Examples

# table overview
print(ResultData$new()$data)
#> $fact #> Empty data.table (0 rows and 8 cols): uhash,iteration,learner_state,prediction,task_hash,learner_hash... #> #>$uhashes
#> Empty data.table (0 rows and 1 cols): uhash
#>
#> $tasks #> Empty data.table (0 rows and 2 cols): task_hash,task #> #>$learners
#> Empty data.table (0 rows and 2 cols): learner_phash,learner
#>
#> $resamplings #> Empty data.table (0 rows and 2 cols): resampling_hash,resampling #> #>$learner_components
#> Empty data.table (0 rows and 2 cols): learner_hash,learner_param_vals
#>