Skip to content

DOC: Added note for corr #53972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 5, 2023
Merged

DOC: Added note for corr #53972

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4a961ab
Added note for corr
rsm-23 Jul 2, 2023
bbae766
Removed additional linebreak
rsm-23 Jul 2, 2023
2cfb6ef
Merge branch 'main' into doc-alignment-process
rsm-23 Jul 4, 2023
f10ab3c
Added example and note for Series.corr
rsm-23 Jul 5, 2023
17a4018
Merge remote-tracking branch 'upstream/main' into doc-alignment-process
rsm-23 Jul 5, 2023
997be09
Update frame.py
rsm-23 Jul 5, 2023
4d306b6
Added operation in example
rsm-23 Jul 5, 2023
fe10268
Fixed indentation error for note
rsm-23 Jul 5, 2023
472ab35
Relocated notes
rsm-23 Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2783,6 +2783,9 @@ def corr(
* `Kendall rank correlation coefficient <https://en.wikipedia.org/wiki/Kendall_rank_correlation_coefficient>`_
* `Spearman's rank correlation coefficient <https://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient>`_
Automatic data alignment: as with all pandas operations, automatic data alignment is performed for this method.
``corr()`` automatically considers values with matching indices.
Examples
--------
>>> def histogram_intersection(a, b):
Expand All @@ -2792,6 +2795,13 @@ def corr(
>>> s2 = pd.Series([.3, .6, .0, .1])
>>> s1.corr(s2, method=histogram_intersection)
0.3
Pandas auto-aligns the values with matching indices
>>> s1 = pd.Series([1, 2, 3], index=[0, 1, 2])
>>> s2 = pd.Series([1, 2, 3], index=[2, 1, 0])
>>> s1.corr(s2)
-1.0
""" # noqa: E501
this, other = self.align(other, join="inner", copy=False)
if len(this) == 0:
Expand Down