polars.pearson_corr

polars.pearson_corr(a: str | Expr, b: str | Expr, ddof: int = 1) → Expr

Compute the pearson’s correlation between two columns.

Deprecated since version 0.16.10: pearson_corr will be removed in favor of corr(..., method="pearson").

Parameters:

a

Column name or Expression.

b

Column name or Expression.

ddof

“Delta Degrees of Freedom”: the divisor used in the calculation is N - ddof, where N represents the number of elements. By default ddof is 1.

See also

corr

Examples

>>> df = pl.DataFrame({"a": [1, 8, 3], "b": [4, 5, 2], "c": ["foo", "bar", "foo"]})
>>> df.select(pl.pearson_corr("a", "b"))
shape: (1, 1)
┌──────────┐
│ a        │
│ ---      │
│ f64      │
╞══════════╡
│ 0.544705 │
└──────────┘