Skip to content

This is a method for the dplyr::explain() generic. This is a generic function which gives more details about an object than print(), and is more focused on human readable output than str().

Usage

# S3 method for class 'duckplyr_df'
explain(x, ...)

Arguments

x

An object to explain

...

Other parameters possibly used by generic

Value

The input, invisibly.

See also

Examples

library(duckplyr)
df <- duckdb_tibble(x = c(1, 2))
df <- mutate(df, y = 2)
explain(df)
#> ┌───────────────────────────┐
#> │         PROJECTION        │
#> │    ────────────────────   │
#> │             x             │
#> │             y             │
#> │                           │
#> │          ~2 Rows          │
#> └─────────────┬─────────────┘
#> ┌─────────────┴─────────────┐
#> │     R_DATAFRAME_SCAN      │
#> │    ────────────────────   │
#> │         data.frame        │
#> │                           │
#> │       Projections: x      │
#> │                           │
#> │          ~2 Rows          │
#> └───────────────────────────┘