grouped.grouped_correlation

grouped.grouped_correlation(ind: Array, v1: Array, v2: Array, filtered: bool = True, chunks: int | tuple[int, ...] | None = None, verbose: bool = False) → ndarray[tuple[int], float64]

Compute the standard deviation at each index.

Parameters:

indarray-like

index labels

v1, v2array-like

data

filteredbool, optional

Filter the output in a pandas dataframe, which is the default. If False, this function returns the raw output, where the index of the value corresponds to the index labels.

chunksint or tuple of ints, optional

Optional chunking of the data, which can be run in parallel in a joblib context

verbosebool, optional

Print timing

:returns: The pearson correlation at each index.

• r: the correlation coefficient

• df: degrees of freedom

• p: the p-value

:rtype: CorrelationResult