Learn R Programming

rtemis (version 0.79)

rtMod-class: rtemis Supervised Model Class

Description

R6 Class for rtemis Supervised Models

Usage

rtMod

Arguments

Format

An object of class R6ClassGenerator of length 24.

Fields

mod.name

Learner algorithm name

y.train

Training y data

y.test

Testing y data

x.name

Name of x data

y.name

Name of y data

xnames

Character vector: Column names of x

mod

Trained model

type

Classification, Regression, or Survival

parameters

List of hyperparameters used when building model

fitted

Fitted values

se.fit

Standard error of the fit

error.train

Training error

predicted

Predicted values

se.prediction

Standard error of the prediction

error.test

Testing error

question

Question the model is hoping to answer

extra

Algorithm-specific output

sessionInfo

The output of sessionInfo() at the time the model was trained

Details

Note on terminology: The training set ('x.train') is used to build a model and calculate training error (rtMod$error.train). The testing set ('x.test') is not seen during training and only used to create predictions (rtMod$predicted) using the trained model and calculate error metrics (rtMod$error.test). This reflects generalizability of the model and is the error we care the most about. The validation set is used during model tuning. Within rtemis, validation sets are created automatically by resample when appropriate, they are not generally input by the user, with few exceptions, as documented in individual functions.