SchaakeShuffleMultiRef: ShaakeShuffleMultiRef class

In SBCK: Statistical Bias Correction Kit

ShaakeShuffleMultiRef class

Description

Match the rank structure of X with them of Y by reordering X.

Details

Can keep multiple features to keep the structure of X.

Public fields

cond_cols

[vector of integer] The conditioning columns

lag_search

[integer] Number of lag to take into account

lag_keep

[integer] Number of lag to keep

Y0

[matrix] Reference data

Methods

Public methods

• SchaakeShuffleMultiRef$new()

• SchaakeShuffleMultiRef$fit()

• SchaakeShuffleMultiRef$predict()

• SchaakeShuffleMultiRef$clone()

---

Method new()

Create a new ShaakeShuffleMultiRef object.

Usage

SchaakeShuffleMultiRef$new(lag_search, lag_keep, cond_cols = base::c(1))

Arguments

lag_search

[integer] Number of lag to take into account

lag_keep

[integer] Number of lag to keep

cond_cols

[vector of integer] The conditioning columns

Returns

A new 'ShaaleShuffleMultiRef' object.

---

Method fit()

Fit the model

Usage

SchaakeShuffleMultiRef$fit(Y0)

Arguments

Y0

[vector] The reference vector

Returns

NULL

---

Method predict()

Fit the model

Usage

SchaakeShuffleMultiRef$predict(X0)

Arguments

X0

[vector] The vector to apply shuffle

Returns

Z0 [vector] data shuffled

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SchaakeShuffleMultiRef$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

X0 = matrix( stats::runif(50) , ncol = 2 )
Y0 = matrix( stats::runif(50) , ncol = 2 )
ssmr = SchaakeShuffleMultiRef$new( lag_search = 3 , lag_keep = 1 , cond_cols = 1 )
ssmr$fit(Y0)
Z0 = ssmr$predict(X0)

SBCK documentation built on Sept. 11, 2023, 5:10 p.m.