dataObject-class {familiar}R Documentation

Data object

Description

The dataObject class is used to resolve the issue of keeping track of pre-processing status and data loading inside complex workflows, e.g. nested predict functions inside a calibration function.

Slots

data

NULL or data table containing the data. This is the data which will be read and used.

preprocessing_level

character indicating the level of pre-processing already conducted.

outcome_type

character, determines the outcome type.

data_column_info

Object containing column information.

delay_loading

logical. Allows delayed loading data, which enables data parsing downstream without additional workflow complexity or memory utilisation.

perturb_level

numeric. This is the perturbation level for data which has not been loaded. Used for data retrieval by interacting with the run table of the accompanying model.

load_validation

logical. This determines which internal data set will be loaded. If TRUE, the validation data will be loaded, whereas FALSE loads the development data.

aggregate_on_load

logical. Determines whether data is aggregated after loading.

sample_set_on_load

NULL or vector of sample identifiers to be loaded.


[Package familiar version 1.4.8 Index]