R: Tiling window calculation

tile {tsibble} | R Documentation

## Tiling window calculation

### Description

Tiling window without overlapping observations:

- `tile()` always returns a list.

- `tile_lgl()`, `tile_int()`, `tile_dbl()`, `tile_chr()` use the same arguments as `tile()`, but return vectors of the corresponding type.

- `tile_dfr()` `tile_dfc()` return data frames using row-binding & column-binding.

### Usage

    tile(.x, .f, ..., .size = 1, .bind = FALSE)

    tile_dfr(.x, .f, ..., .size = 1, .bind = FALSE, .id = NULL)

    tile_dfc(.x, .f, ..., .size = 1, .bind = FALSE)

### Arguments

`.x` | An object to slide over.
`.f` | A function, formula, or vector (not necessarily atomic). If a function, it is used as is. If a formula, e.g. `~ .x + 2`, it is converted to a function. There are three ways to refer to the arguments: For a single argument function, use `.` For a two argument function, use `.x` and `.y` For more arguments, use `..1`, `..2`, `..3` etc This syntax allows you to create very compact anonymous functions. If character vector, numeric vector, or list, it is converted to an extractor function. Character vectors index by name and numeric vectors index by position; use a list to index by position and name at different levels. If a component is not present, the value of `.default` will be returned.
`...` | Additional arguments passed on to the mapped function.
`.size` | An integer for window size. If positive, moving forward from left to right; if negative, moving backward (from right to left).
`.bind` | If `.x` is a list, should `.x` be combined before applying `.f`? If `.x` is a list of data frames, row binding is carried out.
`.id` | Either a string or `NULL`. If a string, the output will contain a variable with that name, storing either the name (if `.x` is named) or the index (if `.x` is unnamed) of the input. If `NULL`, the default, no variable will be created. Only applies to `_dfr` variant.

### See Also

- future_tile for tiling window in parallel

- slide for sliding window with overlapping observations

- stretch for expanding more observations

Other tiling window functions: `tile2`

### Examples

    x <- 1:5
    lst <- list(x = x, y = 6:10, z = 11:15)
    tile_dbl(x, mean, .size = 2)
    tile_lgl(x, ~ mean(.) > 2, .size = 2)
    tile(lst, ~ ., .size = 2)

[Package tsibble version 0.8.2 Index]