roll_idxmax: Rolling Index of Maximums

In roll: Rolling and Expanding Statistics

Rolling Index of Maximums

Description

A function for computing the rolling and expanding index of maximums of time-series data.

Usage

roll_idxmax(x, width, weights = rep(1, width), min_obs = width,
  complete_obs = FALSE, na_restore = FALSE, online = TRUE)

Arguments

x	vector or matrix. Rows are observations and columns are variables.
width	integer. Window size.
weights	vector. Weights for each observation within a window.
min_obs	integer. Minimum number of observations required to have a value within a window, otherwise result is NA.
complete_obs	logical. If TRUE then rows containing any missing values are removed, if FALSE then each value is used.
na_restore	logical. Should missing values be restored?
online	logical. Process observations using an online algorithm.

Value

An object of the same class and dimension as x with the rolling and expanding index of maximums.

Examples

n <- 15
x <- rnorm(n)
weights <- 0.9 ^ (n:1)

# rolling index of maximums with complete windows
roll_idxmax(x, width = 5)

# rolling index of maximums with partial windows
roll_idxmax(x, width = 5, min_obs = 1)

# expanding index of maximums with partial windows
roll_idxmax(x, width = n, min_obs = 1)

# expanding index of maximums with partial windows and weights
roll_idxmax(x, width = n, min_obs = 1, weights = weights)

roll documentation built on May 29, 2024, 6:02 a.m.