nushell/docs/commands/window.md
Justin Ma 0d82d7df60
Update documents for commands (#4796)
* Update documents of commands

* Change plugin names for register command examples

* Remove unused docs [ci skip]
2022-03-09 08:05:35 -05:00

29 lines
528 B
Markdown

---
title: window
layout: command
version: 0.59.1
---
Creates a sliding window of `window_size` that slide by n rows/elements across input.
## Signature
```> window (window_size) --stride```
## Parameters
- `window_size`: the size of each window
- `--stride {int}`: the number of rows to slide over between windows
## Examples
A sliding window of two elements
```shell
> echo [1 2 3 4] | window 2
```
A sliding window of two elements, with a stride of 3
```shell
> [1, 2, 3, 4, 5, 6, 7, 8] | window 2 --stride 3
```