KarsTS (version 2.3)

genTSExample: A function to generate an example time series

Description

This function generates an example time series. The dates range from 2015 to 2016 and the sampling period is half an hour. The time series can be white noise or a random walk. It can be assigned to the KTSEnv environment.

Usage

genTSExample(stationary = TRUE, name = "TS", InKTSEnv = TRUE)

Arguments

stationary

Generate white noise (TRUE) or a random walk (FALSE)

name

A name for the time series. It defaults to TS. When InKTSEnv is FALSE, the name is not necessary.

InKTSEnv

Assign to the environment KTSEnv (TRUE) or not (FALSE)

Value

The time series

Examples

# NOT RUN {
# Generate white noise and assign to the KTSEnv environment
genTSExample(stationary = TRUE, name = "WN")
graphics::plot(KTSEnv$WN, type = "l")

# Generate random walk and not assign to the KTSEnv environment
RW <- genTSExample(stationary = FALSE, InKTSEnv = FALSE)
graphics::plot(RW, type = "l")
# }