Skip to content

Addition to pearsonr documentation #2068

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

Closed
MahatmaCane wants to merge 2 commits into from
Closed

Addition to pearsonr documentation #2068

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb0bd7e
Improve pearsonr docs.
MahatmaCane Jul 1, 2016
b6d0ad1
Improve pearsonr docs.
MahatmaCane Jul 1, 2016
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
7 changes: 5 additions & 2 deletions lib/iris/analysis/stats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,12 @@ def pearsonr(cube_a, cube_b, corr_coords=None, weights=None, mdtol=1.,
Args:

* cube_a, cube_b (cubes):
Cubes between which the correlation will be calculated. The cubes
Cubes between which the correlation will be calculated. The cubes
should either be the same shape and have the same dimension coordinates
or one cube should be broadcastable to the other.
or one cube should be broadcastable to the other. Currently, this means
that common/matching dimensions should have the same length or should have
length 1 in at least one of the cubes when the cubes' shape tuples are
right-aligned.
* corr_coords (str or list of str):
The cube coordinate name(s) over which to calculate correlations. If no
names are provided then correlation will be calculated over all common
Expand Down