add_transform: Transform

View source: R/methods.R

add_transform.tsissm.componentR Documentation

Transform

Description

Transform

Usage

## S3 method for class 'tsissm.component'
add_transform(x, method = "box-cox", lambda = 1, lower = 0, upper = 1, ...)

add_transform(x, ...)

Arguments

x

an object of class tsissm.component or other supported class.

method

a valid transform.

lambda

the Box-Cox parameter.

lower

the lower bound for the logit transform.

upper

the upper bound for the logit transform.

...

additional parameters.

Details

The inverse transform is applied to the simulated series. Valid methods are the “box-cox” and “logit” transforms.

Value

An object of class tsissm.component updated with the transformation.


tsmodels/tssimulator documentation built on April 29, 2024, 9:11 a.m.