Skip to content
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

Correct documentation #352

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Correct documentation #352

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0491516
Correct documentation
JasonSteelmanCoder Nov 6, 2024
29da6a4
clarify when 'O' is permissible
JasonSteelmanCoder Nov 12, 2024
c47fd36
clarify when 'O' is permissible
JasonSteelmanCoder Nov 12, 2024
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
13 changes: 7 additions & 6 deletions esda/moran.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ class Moran:
transformation : string
weights transformation, default is row-standardized "r".
Other options include "B": binary, "D":
doubly-standardized, "U": untransformed
doubly-standardized, "O": restore original transformation
(applicable only if ``w`` is passed as ``W``)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This clarification should be present in all docstrings below.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Sorry--I'm a bit new at the pull request thing. I updated all of the docstrings in my own repository, but those changes weren't reflected here. How do I make the changes show up in the pull request itself, without opening a new PR? Thanks for bearing with me.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I think I've figured it out. Thanks again for bearing with me as I learn!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I think I've figured it out. Thanks again for bearing with me as I learn!

@JasonSteelmanCoder Your contribution is important for us and we welcome your efforts!

(general weights), "V": variance-stabilizing.
permutations : int
number of random permutations for calculation of
Expand Down Expand Up @@ -337,7 +338,7 @@ class Moran_BV: # noqa: N801
Other options include
"B": binary,
"D": doubly-standardized,
"U": untransformed (general weights),
"O": restore original transformation (general weights),
"V": variance-stabilizing.
permutations : int
number of random permutations for calculation of pseudo
Expand Down Expand Up @@ -655,7 +656,7 @@ class Moran_Rate(Moran): # noqa: N801
Other options include
"B": binary,
"D": doubly-standardized,
"U": untransformed (general weights),
"O": restore original transformation (general weights),
"V": variance-stabilizing.
two_tailed : boolean
If True (default), analytical p-values for Moran's I are
Expand Down Expand Up @@ -889,7 +890,7 @@ class Moran_Local: # noqa: N801
Other options include
"B": binary,
"D": doubly-standardized,
"U": untransformed (general weights),
"O": restore original transformation (general weights),
"V": variance-stabilizing.
permutations : int
number of random permutations for calculation of pseudo
Expand Down Expand Up @@ -1263,7 +1264,7 @@ class Moran_Local_BV: # noqa: N801
Other options include
"B": binary,
"D": doubly-standardized,
"U": untransformed (general weights),
"O": restore original transformation (general weights),
"V": variance-stabilizing.
permutations : int
number of random permutations for calculation of pseudo
Expand Down Expand Up @@ -1533,7 +1534,7 @@ class Moran_Local_Rate(Moran_Local): # noqa: N801
Other options include
"B": binary,
"D": doubly-standardized,
"U": untransformed (general weights),
"O": restore original transformation (general weights),
"V": variance-stabilizing.
permutations : int
number of random permutations for calculation of pseudo
Expand Down