mirror of
https://github.com/nushell/nushell.git
synced 2025-08-14 01:58:37 +02:00
Auto-generate markdown command docs (#4451)
* Finish updating * a couple improvements * Update renames * cleanup examples
This commit is contained in:
37
docs/commands/dfr_aggregate.md
Normal file
37
docs/commands/dfr_aggregate.md
Normal file
@ -0,0 +1,37 @@
|
||||
---
|
||||
title: dfr aggregate
|
||||
layout: command
|
||||
version: 0.59.0
|
||||
---
|
||||
|
||||
Performs an aggregation operation on a dataframe and groupby object
|
||||
|
||||
## Signature
|
||||
|
||||
```> dfr aggregate (operation-name) --quantile --explicit```
|
||||
|
||||
## Parameters
|
||||
|
||||
- `operation-name`:
|
||||
Dataframes: mean, sum, min, max, quantile, median, var, std
|
||||
GroupBy: mean, sum, min, max, first, last, nunique, quantile, median, var, std, count
|
||||
- `--quantile {number}`: quantile value for quantile operation
|
||||
- `--explicit`: returns explicit names for groupby aggregations
|
||||
|
||||
## Examples
|
||||
|
||||
Aggregate sum by grouping by column a and summing on col b
|
||||
```shell
|
||||
> [[a b]; [one 1] [one 2]] | dfr to-df | dfr group-by a | dfr aggregate sum
|
||||
```
|
||||
|
||||
Aggregate sum in dataframe columns
|
||||
```shell
|
||||
> [[a b]; [4 1] [5 2]] | dfr to-df | dfr aggregate sum
|
||||
```
|
||||
|
||||
Aggregate sum in series
|
||||
```shell
|
||||
> [4 1 5 6] | dfr to-df | dfr aggregate sum
|
||||
```
|
||||
|
Reference in New Issue
Block a user