Unnest the Struct columns of a DataFrame

Description

Usage

<DataFrame>$unnest(...)

Arguments

`…`	Names of the struct columns to unnest. This doesn’t accept Expr. If nothing is provided, then all columns of datatype Struct are unnested.

Value

A DataFrame where some or all columns of datatype Struct are unnested.

Examples

library("polars")

df = pl$DataFrame(
  a = 1:5,
  b = c("one", "two", "three", "four", "five"),
  c = 6:10
)$
  select(
  pl$struct("b"),
  pl$struct(c("a", "c"))$alias("a_and_c")
)
df

#> shape: (5, 2)
#> ┌───────────┬───────────┐
#> │ b         ┆ a_and_c   │
#> │ ---       ┆ ---       │
#> │ struct[1] ┆ struct[2] │
#> ╞═══════════╪═══════════╡
#> │ {"one"}   ┆ {1,6}     │
#> │ {"two"}   ┆ {2,7}     │
#> │ {"three"} ┆ {3,8}     │
#> │ {"four"}  ┆ {4,9}     │
#> │ {"five"}  ┆ {5,10}    │
#> └───────────┴───────────┘

# by default, all struct columns are unnested
df$unnest()

#> shape: (5, 3)
#> ┌───────┬─────┬─────┐
#> │ b     ┆ a   ┆ c   │
#> │ ---   ┆ --- ┆ --- │
#> │ str   ┆ i32 ┆ i32 │
#> ╞═══════╪═════╪═════╡
#> │ one   ┆ 1   ┆ 6   │
#> │ two   ┆ 2   ┆ 7   │
#> │ three ┆ 3   ┆ 8   │
#> │ four  ┆ 4   ┆ 9   │
#> │ five  ┆ 5   ┆ 10  │
#> └───────┴─────┴─────┘

# we can specify specific columns to unnest
df$unnest("a_and_c")

#> shape: (5, 3)
#> ┌───────────┬─────┬─────┐
#> │ b         ┆ a   ┆ c   │
#> │ ---       ┆ --- ┆ --- │
#> │ struct[1] ┆ i32 ┆ i32 │
#> ╞═══════════╪═════╪═════╡
#> │ {"one"}   ┆ 1   ┆ 6   │
#> │ {"two"}   ┆ 2   ┆ 7   │
#> │ {"three"} ┆ 3   ┆ 8   │
#> │ {"four"}  ┆ 4   ┆ 9   │
#> │ {"five"}  ┆ 5   ┆ 10  │
#> └───────────┴─────┴─────┘