Summary statistics for a DataFrame
Description
This returns the total number of rows, the number of missing values, the
mean, standard deviation, min, max, median and the percentiles specified
in the argument percentiles.
Usage
<DataFrame>$describe(percentiles = c(0.25, 0.75), interpolation = "nearest")
Arguments
percentiles
|
One or more percentiles to include in the summary statistics. All values
must be in the range \[0; 1\].
|
interpolation
|
Interpolation method for computing quantiles. One of
“nearest”, “higher”, “lower”,
“midpoint”, or “linear”.
|
Value
DataFrame
Examples
#> shape: (9, 6)
#> ┌────────────┬──────────────────┬──────────────────┬─────────────────┬─────────────────┬───────────┐
#> │ statistic ┆ Sepal.Length ┆ Sepal.Width ┆ Petal.Length ┆ Petal.Width ┆ Species │
#> │ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │
#> │ str ┆ str ┆ str ┆ str ┆ str ┆ str │
#> ╞════════════╪══════════════════╪══════════════════╪═════════════════╪═════════════════╪═══════════╡
#> │ count ┆ 150 ┆ 150 ┆ 150 ┆ 150 ┆ 150 │
#> │ null_count ┆ 0 ┆ 0 ┆ 0 ┆ 0 ┆ 0 │
#> │ mean ┆ 5.84333333333333 ┆ 3.05733333333333 ┆ 3.7579999999999 ┆ 1.1993333333333 ┆ null │
#> │ ┆ 4 ┆ 32 ┆ 996 ┆ 336 ┆ │
#> │ std ┆ 0.82806612797786 ┆ 0.43586628493669 ┆ 1.7652982332594 ┆ 0.7622376689603 ┆ null │
#> │ ┆ 28 ┆ 82 ┆ 667 ┆ 465 ┆ │
#> │ min ┆ 4.3 ┆ 2.0 ┆ 1.0 ┆ 0.1 ┆ setosa │
#> │ 25% ┆ 5.1 ┆ 2.8 ┆ 1.6 ┆ 0.3 ┆ null │
#> │ 50% ┆ 5.8 ┆ 3.0 ┆ 4.4 ┆ 1.3 ┆ null │
#> │ 75% ┆ 6.4 ┆ 3.3 ┆ 5.1 ┆ 1.8 ┆ null │
#> │ max ┆ 7.9 ┆ 4.4 ┆ 6.9 ┆ 2.5 ┆ virginica │
#> └────────────┴──────────────────┴──────────────────┴─────────────────┴─────────────────┴───────────┘
# string, date, boolean columns are also supported:
df = pl$DataFrame(
int = 1:3,
string = c(letters[1:2], NA),
date = c(as.Date("2024-01-20"), as.Date("2024-01-21"), NA),
cat = factor(c(letters[1:2], NA)),
bool = c(TRUE, FALSE, NA)
)
df
#> shape: (3, 5)
#> ┌─────┬────────┬────────────┬──────┬───────┐
#> │ int ┆ string ┆ date ┆ cat ┆ bool │
#> │ --- ┆ --- ┆ --- ┆ --- ┆ --- │
#> │ i32 ┆ str ┆ date ┆ cat ┆ bool │
#> ╞═════╪════════╪════════════╪══════╪═══════╡
#> │ 1 ┆ a ┆ 2024-01-20 ┆ a ┆ true │
#> │ 2 ┆ b ┆ 2024-01-21 ┆ b ┆ false │
#> │ 3 ┆ null ┆ null ┆ null ┆ null │
#> └─────┴────────┴────────────┴──────┴───────┘
#> shape: (9, 6)
#> ┌────────────┬─────┬────────┬────────────┬──────┬───────┐
#> │ statistic ┆ int ┆ string ┆ date ┆ cat ┆ bool │
#> │ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │
#> │ str ┆ str ┆ str ┆ str ┆ str ┆ str │
#> ╞════════════╪═════╪════════╪════════════╪══════╪═══════╡
#> │ count ┆ 3 ┆ 2 ┆ 2 ┆ 2 ┆ 2 │
#> │ null_count ┆ 0 ┆ 1 ┆ 1 ┆ 1 ┆ 1 │
#> │ mean ┆ 2.0 ┆ null ┆ null ┆ null ┆ null │
#> │ std ┆ 1.0 ┆ null ┆ null ┆ null ┆ null │
#> │ min ┆ 1 ┆ a ┆ 2024-01-20 ┆ a ┆ false │
#> │ 25% ┆ 2.0 ┆ null ┆ null ┆ null ┆ null │
#> │ 50% ┆ 2.0 ┆ null ┆ null ┆ null ┆ null │
#> │ 75% ┆ 3.0 ┆ null ┆ null ┆ null ┆ null │
#> │ max ┆ 3 ┆ b ┆ 2024-01-21 ┆ b ┆ true │
#> └────────────┴─────┴────────┴────────────┴──────┴───────┘