TrainData: TrainData Class

TrainDataR Documentation

TrainData Class

Description

This class implements the training data. A TrainData object can only exist as a component of a TrainLayer or a TrainMetaLayer object.

Super class

fuseMLR::Data -> TrainData

Methods

Public methods

Inherited methods

Method new()

Initialize a new object from the current class.

Usage
TrainData$new(id, data_frame, train_layer)
Arguments
id

character
The Object ID.

data_frame

data.frame
data.frame containing data.

train_layer

TrainLayer
Training layer where to store the current object.


Method print()

Printer

Usage
TrainData$print(...)
Arguments
...

any


Method summary()

Summary

Usage
TrainData$summary(...)
Arguments
...

any


Method getData()

Getter of the current data.frame wihtout individual ID nor target variables.

Usage
TrainData$getData()
Returns

The data.frame without individual ID nor target variables is returned.


Method getTargetValues()

Getter of target values stored on the current training layer.

Usage
TrainData$getTargetValues()
Returns

The observed target values stored on the current training layer are returned.


Method getTargetName()

Getter of the target variable name.

Usage
TrainData$getTargetName()

Method getTrainLayer()

Getter of the current training layer.

Usage
TrainData$getTrainLayer()
Returns

The training layer (from class TrainLayer) on which the current train data are stored is returned.


Method getTestLayer()

Getter of the current layer.

Usage
TrainData$getTestLayer()
Returns

The layer (from class TestLayer) on which the current train data are stored is returned.


Method setDataFrame()

Set a new data.frame to the current object.

Usage
TrainData$setDataFrame(data_frame)
Arguments
data_frame

data.frame

Returns

The current object is returned.


Method clone()

The objects of this class are cloneable with this method.

Usage
TrainData$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

TrainLayer, Lrner, Model, TestData


fuseMLR documentation built on April 3, 2025, 8:49 p.m.