Kotlin / dataframe

Structured data processing in Kotlin
https://kotlin.github.io/dataframe/overview.html
Apache License 2.0
833 stars 60 forks source link

Pivot table horizontal grouping, is it supported? #97

Open hfazai opened 2 years ago

hfazai commented 2 years ago

Thanks for creating this great library :+1: !

I follow this documentation to create a pivot table.

Is it possible to make an horizontal grouping like in this example (add gender to rows) ?

pivot { col1 then col2 } .groupBy { row1 and row2 } col1 and c2 are grouped hierarchically but row1 and row2 are not.

koperagen commented 2 years ago

Hi! Can you provide a screenshot of the desired table and what you get with pivot { col1 then col2 } .groupBy { row1 and row2 }? What i see on the link: image Not sure if this is the desired table

hfazai commented 2 years ago

Hi, With pivot { "Party" } .groupBy { "Province" and "Gender" }.sum("Age") I want to get: image

Using dataframe I get Provinceand Gender pivoted independently :

Alberta, Female, ...
.....
Alberta, Male, ...
hfazai commented 2 years ago

@koperagen Maybe we need to have the function then in ColumnsSelectionDsl like in PivotDsl. This way, my expression become: pivot { "Party" } .groupBy { "Province" then "Gender" }.sum("Age")

koperagen commented 2 years ago

Thank you for the use case, it's very interesting! Maybe df.pivot { Gender then Party }.groupBy { Province }.sum { Age } does the thing? It yields a dataframe with this schema: image

hfazai commented 2 years ago

If I have to group only two columns, df.pivot { Gender then Party }.groupBy { Province }.sum { Age } does the thing. But actualy I'm using dataframe to add the Pivot Table feature to the framework Galite. It should allow grouping data by rows and by columns. How could I make the table below with dataframe? image I have gender and smoker grouped horizontally / day and time are grouped vertically.

koperagen commented 2 years ago

Now that you mention horizontal / vertical grouping, documentation states https://kotlin.github.io/dataframe/pivot.html

df.pivot { pivotColumns }.groupBy { indexColumns }
pivotColumns — columns with values for horizontal data grouping and generation of new columns
indexColumns — columns with values for vertical data grouping

According to I have gender and smoker grouped horizontally / day and time are grouped vertically. this code should work: df.pivot { smoker then gender }.groupBy { day and time } Does it work as you would expect?

Also, can you share this dataset if it's public?

hfazai commented 2 years ago

df.pivot { smoker then gender }.groupBy { day and time } Gives: Update: df.pivot { day then time }.groupBy { gender and smoker } Gives: image

My actual workaround is to sort Values on the rows and try to span them df.pivot { smoker then gender }.groupBy { day and time }.sortBy { day and time } which gives: Update: My actual workaround is to sort Values on the rows and try to span them df.pivot { day then time }.groupBy { gender and smoker }.sortBy { gender and smoker } which gives: image

koperagen commented 2 years ago

I see the problem, yes. Can you provide the dataset so i can give it a try myself? It would be easier for me to figure it out in REPL :) Or we can pick other dataset

nikitinas commented 2 years ago

Hi, @hfazai. As far as I understand, you need hierarchical grouping of rows, so that df.groupBy { a then b } will return DataFrame with a single row for every distinct a value and every row will contain nested DataFrame grouped by b. Currently DataFrame supports nesting only for columns, but not for rows. It is a good feature request, thank you! We'll consider it

nikitinas commented 2 years ago

Currently this is the only way to perform something similar to nested rows:

Screen Shot 2022-04-19 at 15 53 27
hfazai commented 2 years ago

I see the problem, yes. Can you provide the dataset so i can give it a try myself? It would be easier for me to figure it out in REPL :) Or we can pick other dataset

Try: val df = DataFrame.read("https://pivottable.js.org/examples/mps.csv")

hfazai commented 2 years ago

Hi, @hfazai. As far as I understand, you need hierarchical grouping of rows, so that df.groupBy { a then b } will return DataFrame with a single row for every distinct a value and every row will contain nested DataFrame grouped by b. Currently DataFrame supports nesting only for columns, but not for rows. It is a good feature request, thank you! We'll consider it

Hi @nikitinas, yes exactly :)

hfazai commented 2 years ago

Currently this is the only way to perform something similar to nested rows:

I'll try it, thanks! Actually I did a workaround with the sortBy { } and it works fine and it would be great to add this feature by adding then to ColumnsSelectionDsl so that we can call df.groupBy { a then b }

nikitinas commented 2 years ago

My actual workaround is to sort Values on the rows and try to span them df.pivot { smoker then gender }.groupBy { day and time }.sortBy { day and time } which gives: image

I can't match this image with your code. According to attached screenshot, you do df.groupBy { gender and smoker }.pivot { day then time }.sortBy { gender and smoker } And you want df.groupBy { gender then smoker }.pivot { day and time } to have all rows with the same gender stored consequently (by default, without sorting) and also merge equal values in gender vertically. Is it correct?

hfazai commented 2 years ago

Yes, sorry I was wrong I copied the last code in my tests, I mean df.groupBy { gender and smoker }.pivot { day then time }.sortBy { gender and smoker }

nikitinas commented 2 years ago

Let's discuss implementation.

An obvious solution is to add GroupedDataRow that will store value for the first grouping key and nested DataFrame with other grouping keys. It will be similar to FrameColumn from my previous comment:

Screen Shot 2022-04-19 at 16 24 24

but will have a better presentation: nested DataFrames will be injected into the root table without expanders and group column.

This approach raises several questions:

I think that fair implementation of row grouping may overcomplicate DataFrame usage. I assume that in most cases grouped rows are needed only for better visual representation, so we can just add some info into DataColumn API with span ranges indicating subsequent values that should be rendered in a single merged cell. So internally nothing will change and such "merged" column will behave just as any other column. What do you think about it?

nikitinas commented 2 years ago

And we also should add groupBy { a then b }.

hfazai commented 2 years ago

we can just add some info into DataColumn API with span ranges indicating subsequent values that should be rendered in a single merged cell. So internally nothing will change and such "merged" column will behave just as any other column. What do you think about it?

I agree with you concerns about changing the internal implementation. The solution of adding the additional informations about the row grouping looks good to me. I think to add span ranges indicating subsequent values that should be rendered in a single merged cell, the groupBy { a then b } should sort the rows before.

nikitinas commented 2 years ago

I think that sorting should be performed explicitly, because in some cases original order of rows must be preserved. We can add .asc() and .desc() modifiers in column selector, similar to sortBy: df.groupBy { a.asc() and b.desc() }

hfazai commented 2 years ago

Sounds good :+1: