lags.: Get lagging or leading values

Description Usage Arguments Examples

View source: R/lag-lead.R

Description

Find the "previous" or "next" values in a vector. Useful for comparing values behind or ahead of the current values.

Usage

1
2
3
lags.(x, n = 1L, default = NA)

leads.(x, n = 1L, default = NA)

Arguments

x

a vector of values

n

a positive integer of length 1, giving the number of positions to lead or lag by

default

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
x <- 1:5

leads.(x, 1)
lags.(x, 1)

# Also works inside of `mutate.()`
test_df <- tidytable(x = 1:5)

test_df %>%
  mutate.(lag_x = lags.(x))

mtfairbanks/gdt documentation built on May 4, 2021, 9:44 a.m.