rtXDecom-class: R6 class for 'rtemis' cross-decompositions

rtXDecom-classR Documentation

R6 class for rtemis cross-decompositions

Description

R6 class for rtemis cross-decompositions

R6 class for rtemis cross-decompositions

Details

rtemis cross-decomposition R6 object

Public fields

xdecom.name

Character: Name of cross-decomposition algorithm

k

Integer: Number of projections

xnames

Character vector: Column names of x

znames

Character vector: Column names of z

xdecom

Cross-decomposition model output

xprojections.train

x data training set projections

xprojections.test

x data test set data projections

zprojections.train

z data training set projections

zprojections.test

z data test set projections

parameters

Cross-decomposition parameters

extra

List: Algorithm-specific output

Methods

Public methods


Method new()

Usage
rtXDecom$new(
  xdecom.name = character(),
  k = integer(),
  xnames = character(),
  znames = character(),
  xdecom = list(),
  xprojections.train = numeric(),
  xprojections.test = numeric(),
  zprojections.train = numeric(),
  zprojections.test = numeric(),
  parameters = list(),
  extra = list()
)
Arguments
xdecom.name

Character: Name of cross-decomposition algorithm

k

Integer: Number of projections

xnames

Character vector: Column names of x

znames

Character vector: Column names of z

xdecom

Cross-decomposition model output

xprojections.train

x data training set projections

xprojections.test

x data test set data projections

zprojections.train

z data training set projections

zprojections.test

z data test set projections

parameters

Cross-decomposition parameters

extra

List: Algorithm-specific output


Method print()

Print method for rtXDecom objects

Usage
rtXDecom$print()

Method clone()

The objects of this class are cloneable with this method.

Usage
rtXDecom$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

E.D. Gennatas


egenn/rtemis documentation built on April 24, 2024, 6:58 p.m.