KarsTS (version 2.3)

genGapExample: A function to generate a gap set example

Description

A function to generate a gap set example.It can be assigned to the KTSEnv environment.

Usage

genGapExample(timSer, lGaps, nGaps, name = "GS", InKTSEnv = TRUE)

Arguments

timSer

The time series where the gaps are generated

lGaps

The length of the gaps

nGaps

The number of gaps

name

A name for the gap set. It defaults to GS. When InKTSEnv is FALSE, the name is not necessary.

InKTSEnv

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

Value

The gap set

Examples

# NOT RUN {
# Generate a time series

RW <- genTSExample(stationary = FALSE, InKTSEnv = FALSE)

# Generate 2 gaps of 50 NAs each
G.2.50 <- genGapExample(RW, 50, 2, InKTSEnv = FALSE)

RW1 <- RW
RW1$value[G.2.50$gaps] <- NA
graphics::plot(RW, type = "l", col = "red")
graphics::points(RW1, type = "l", col = "blue")

# The same in the environment KTSEnv
removeIfExists(c("G.2.50","RW1"), envir = environment())
genGapExample(RW, 50, 2, name = "G.2.50")

RW1 <- RW
RW1$value[KTSEnv$G.2.50$gaps] <- NA
graphics::plot(RW, type = "l", col = "red")
graphics::points(RW1, type = "l", col = "blue")

# }