Correct documentation #352
Conversation
Setting transformation to "U" causes an "unsupported weights transformation" exception because "U" is not an accepted parameter of the set_transform method of the libpysal.weights.W class. The correct argument is "O", which is described in the libpysal.weights.W documentation as "Restore original transformation (from instantiation)". I've updated the documentation to reflect that.
There was a problem hiding this comment.
Thanks, this is indeed a correct formulation when libpysal.weights.W object is passed. When libpysal.graph.Graph object is passed as w, this statement does not apply as the Graph is immutable and does not contain the original untransformed weights (by design).
Co-authored-by: Martin Fleischmann <[email protected]>
| @@ -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``) | |||
There was a problem hiding this comment.
This clarification should be present in all docstrings below.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Actually, I think I've figured it out. Thanks again for bearing with me as I learn!
There was a problem hiding this comment.
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!
|
Is this ready to be merged? |
Setting transformation to "U" causes an "unsupported weights transformation" exception because "U" is not an accepted parameter of the set_transform method of the libpysal.weights.W class. The correct argument is "O", which is described in the libpysal.weights.W documentation as "Restore original transformation (from instantiation)". I've updated the documentation to reflect that.