Corr  type: corr

class lumen.transforms.base.Corr(*, method, min_periods, numeric_only, controls, name)

Corr computes pairwise correlation of columns, excluding NA/null values.

---

Parameters

method

type: Any
default: 'pearson'
Possible values: 'pearson' | 'kendall' | 'spearman'
Method of correlation.

min_periods

type: int
default: 1
bounds: None
Minimum number of observations required per pair of columnsto have a valid result. Currently only available for Pearsonand Spearman correlation.

numeric_only

type: bool
default: False
Include only float, int or boolean data.

---

Methods

Corr.apply(table: DataFrame) → DataFrame

Given a table transform it in some way and return it.

Parameters:

table (DataFrame) – The queried table as a DataFrame.

Returns:

A DataFrame containing the transformed data.

Return type:

DataFrame

Corr.to_spec(context: dict[str, Any] | None = None) → dict[str, Any]

Exports the full specification to reconstruct this component.

Return type:

Resolved and instantiated Component object