SchaakeShuffle: ShaakeShuffle class

In SBCK: Statistical Bias Correction Kit

ShaakeShuffle class

Description

Perform the Schaake Shuffle

Details

as fit/predict mode

Methods

Public methods

• SchaakeShuffle$new()

• SchaakeShuffle$fit()

• SchaakeShuffle$predict()

• SchaakeShuffle$clone()

---

Method new()

Create a new ShaakeShuffle object.

Usage

SchaakeShuffle$new(Y0 = NULL)

Arguments

Y0

[vector] The reference vector

Returns

A new 'ShaaleShuffle' object.

---

Method fit()

Fit the model

Usage

SchaakeShuffle$fit(Y0)

Arguments

Y0

[vector] The reference vector

Returns

NULL

---

Method predict()

Fit the model

Usage

SchaakeShuffle$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

SchaakeShuffle$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

X0 = matrix( stats::runif(20) , ncol = 2 )
Y0 = matrix( stats::runif(20) , ncol = 2 )
ss = SchaakeShuffle$new()
ss$fit(Y0)
Z0 = ss$predict(X0)

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