tsibble (version 1.1.3)

difference: Lagged differences

Description

lifecycle::badge("stable")

Usage

difference(x, lag = 1, differences = 1, default = NA, order_by = NULL)

Value

A numeric vector of the same length as x.

Arguments

x

Vector of values

lag

A positive integer indicating which lag to use.

differences

A positive integer indicating the order of the difference.

default

Value used for non-existent rows. Defaults to NA.

order_by

Override the default ordering to use another vector or column

See Also

dplyr::lead and dplyr::lag

Examples

# examples from base
difference(1:10, 2)
difference(1:10, 2, 2)
x <- cumsum(cumsum(1:10))
difference(x, lag = 2)
difference(x, differences = 2)
# Use order_by if data not already ordered (example from dplyr)
library(dplyr, warn.conflicts = FALSE)
tsbl <- tsibble(year = 2000:2005, value = (0:5)^2, index = year)
scrambled <- tsbl %>% slice(sample(nrow(tsbl)))

wrong <- mutate(scrambled, diff = difference(value))
arrange(wrong, year)

right <- mutate(scrambled, diff = difference(value, order_by = year))
arrange(right, year)