Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing pivot docs and example #273

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Fixing pivot docs and example #273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions polars/dataframe.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,7 @@ export interface DataFrame
*/
melt(idVars: ColumnSelection, valueVars: ColumnSelection): DataFrame;
/**
* Unpivot DataFrame to long format.
* Unpivot a DataFrame from wide to long format.
* ___
*
* @param idVars - Columns to use as identifier variables.
Expand Down Expand Up @@ -1029,9 +1029,15 @@ export interface DataFrame
/**
* Create a spreadsheet-style pivot table as a DataFrame.
*
* @param values Column values to aggregate. Can be multiple columns if the *columns* arguments contains multiple columns as well
* @param options.index One or multiple keys to group by
* @param options.columns Columns whose values will be used as the header of the output DataFrame
* @param values The existing column(s) of values which will be moved under the new columns from index. If an
* aggregation is specified, these are the values on which the aggregation will be computed.
* If None, all remaining columns not specified on `on` and `index` will be used.
* At least one of `index` and `values` must be specified.
* @param options.index The column(s) that remain from the input to the output. The output DataFrame will have one row
* for each unique combination of the `index`'s values.
* If None, all remaining columns not specified on `on` and `values` will be used. At least one
* of `index` and `values` must be specified.
* @param options.on The column(s) whose values will be used as the new columns of the output DataFrame.
* @param options.aggregateFunc
* Any of:
* - "sum"
Expand All @@ -1055,7 +1061,7 @@ export interface DataFrame
* ... "baz": [1, 2, 3, 4, 5, 6],
* ... }
* ... );
* > df.pivot("baz", {index:"foo", columns:"bar"});
* > df.pivot("baz", {index:"foo", on:"bar"});
* shape: (2, 4)
* ┌─────┬─────┬─────┬─────┐
* │ foo ┆ A ┆ B ┆ C │
Expand Down