pandas 1.4.2

NotesParametersReturns
corr(self, other: 'DataFrame | Series | None' = None, pairwise: 'bool | None' = None, ddof: 'int' = 1, **kwargs)

Notes

This function uses Pearson's definition of correlation (https://en.wikipedia.org/wiki/Pearson_correlation_coefficient).

When other is not specified, the output will be self correlation (e.g. all 1's), except for ~pandas.DataFrame inputs with :None:None:`pairwise` set to :None:None:`True`.

Function will return NaN for correlations of equal valued sequences; this is the result of a 0/0 division error.

When :None:None:`pairwise` is set to :None:None:`False`, only matching columns between :None:None:`self` and other will be used.

When :None:None:`pairwise` is set to :None:None:`True`, the output will be a MultiIndex DataFrame with the original index on the first level, and the other DataFrame columns on the second level.

In the case of missing elements, only complete pairwise observations will be used.

Parameters

other : Series or DataFrame, optional

If not supplied then will default to self and produce pairwise output.

pairwise : bool, default None

If False then only matching columns between self and other will be used and the output will be a DataFrame. If True then all pairwise combinations will be calculated and the output will be a MultiIndexed DataFrame in the case of DataFrame inputs. In the case of missing elements, only complete pairwise observations will be used.

**kwargs :

For NumPy compatibility and will not have an effect on the result.

Returns

Series or DataFrame

Return type is the same as the original object with np.float64 dtype.

Calculate the expanding correlation.

See Also

cov

Similar method to calculate covariance.

numpy.corrcoef

NumPy Pearson's correlation calculation.

pandas.DataFrame.corr

Aggregating corr for DataFrame.

pandas.DataFrame.expanding

Calling expanding with DataFrames.

pandas.Series.corr

Aggregating corr for Series.

pandas.Series.expanding

Calling expanding with Series data.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /pandas/core/window/expanding.py#722
type: <class 'function'>
Commit: