runner (version 0.1.0)

max_run: Running maximum

Description

max_run calculates running max on given x numeric vector and specified k window size.

Usage

max_run(x, k = 0L, na_rm = TRUE, na_pad = FALSE)

Arguments

x

input numeric vector where running maximum is calculated.

k

Running window size. By default window size equals length(x). Allow varying window size specified by vector of length(x)

na_rm

logical (default na_rm=TRUE) - if TRUE NA are replaced by last observed maximum prior to element.

na_pad

logical (default na_pad=FALSE) - if TRUE first k-results will be filled by NA. If k is not specified na_pad=F by default.

Value

numeric vector of length equals length of x containing running max in k-long window.

Examples

# NOT RUN {
set.seed(11)
x1 <- sample(c(1,2,3), 15, replace=TRUE)
x2 <- sample(c(NA,1,2,3), 15, replace=TRUE)
k  <- sample(1:4, 15,replace=TRUE)
max_run(x1) # simple cumulative minimum
max_run(x2, na_rm = TRUE) # cumulative minimum with removing NA.
max_run(x2, na_rm = TRUE, k=4) # minimum in 4-element window
max_run(x2, na_rm = FALSE, k=k) # minimum in varying k window size
# }