window.piar_index {piar}R Documentation

Index window

Description

Extract and replace index values over a window of time periods.

Usage

## S3 method for class 'piar_index'
window(x, start = NULL, end = NULL, ...)

## S3 replacement method for class 'piar_index'
window(x, start = NULL, end = NULL, ...) <- value

Arguments

x

A price index, as made by, e.g., elemental_index().

start

The time period to start the window. The default in the first period of x.

end

The time period to end the window. The default is the last period of x.

...

Not currently used.

value

A numeric vector or price index.

Value

window() extracts a price index over a window of time periods that inherits from the same class as x. The replacement method replaces these with value.

See Also

Other index methods: [.piar_index(), aggregate.piar_index, as.data.frame.piar_index(), chain(), contrib(), head.piar_index(), is.na.piar_index(), levels.piar_index(), mean.piar_index, merge.piar_index(), split.piar_index(), stack.piar_index(), time.piar_index()

Examples

x <- as_index(matrix(1:9, 3))

window(x, "2")

window(x, "2") <- 1
x


[Package piar version 0.8.1 Index]