bracketbracket-methods: Methods for '[[' in package 'lagged'

In lagged: Classes and Methods for Lagged Objects

Methods for '[[' in package 'lagged'

Description

Methods for '[[' in package 'lagged'.

Methods

Indexing with "[[" returns the value for the specified lag. The index should be a single number.

This is the recommended way to extract the value at a single index.

signature(x = "FlexibleLagged", i = "ANY", j = "ANY")

signature(x = "Lagged", i = "numeric", j = "missing")

signature(x = "Lagged2d", i = "numeric", j = "logical")

signature(x = "Lagged2d", i = "numeric", j = "numeric")

signature(x = "slMatrix", i = "numeric", j = "ANY")

signature(x = "Lagged2d", i = "missing", j = "numeric")

signature(x = "Lagged2d", i = "numeric", j = "missing")

signature(x = "FlexibleLagged", i = "missing", j = "numeric")

signature(x = "FlexibleLagged", i = "numeric", j = "missing")

Examples

## for 1d objects the difference of '[' and '[[' is not visible
(acv1 <- acf2Lagged(acf(ldeaths, plot = FALSE)))
acv1[1]
acv1[[1]]

## in higher dimenions it matters
acv2 <- acf2Lagged(acf(ts.union(mdeaths, fdeaths), plot = FALSE))
acv2[0]   # array
acv2[[0]] # matrix

## as in standard R conventions, '[' can select arbitrary number of elements
acv2[0:1]
## ... while '[[' selects only one, so this is an error:
## Not run: 
acv2[[0:1]]

## End(Not run)

## Lagged2
m <- matrix(10:49, nrow = 4, byrow = TRUE)
m_lagged <- Lagged(m)
m_lagged

## one index: lag
m_lagged[0:1]
m_lagged[0]   # column vector
m_lagged[[0]] # numeric
## two indices: first is row, second is lag
m_lagged[1 , 0]     # '[' doesn't drop dimensions
m_lagged[1 , 0:3]

m_lagged[[1 , 0]]   # '[[' does drop dimensions
m_lagged[[1 , 0:3]]
m_lagged[[1, TRUE]] # the whole first row, as numeric

m_lagged[1:2 , 0:3] # ok, a matrix
## ... but the first arg. of '[[' must be of length one,
## so this throws error:
## Not run: 
m_lagged[[1:2 , 0:3]]

## End(Not run)

lagged documentation built on Aug. 7, 2022, 5:19 p.m.