write_catalog and subfunctions write out weights as correlation squared. While this is documented it is only documented in one place. This PR adds an option to output weights as raw correlations and slightly more relevant documentation for this.
Why was it initiated? Any relevant Issues?
No known issues, but users have been surprised to see correlation squared weights.
PR Checklist
[x] develop base branch selected?
[x] This PR is not directly related to an existing issue (which has no PR yet).
[x] All tests still pass.
[x] Any new features or fixed regressions are be covered via new tests.
[x] Any new or changed features have are fully documented.
[x] Significant changes have been added to CHANGES.md.
- [ ] First time contributors have added your name to CONTRIBUTORS.md.
What does this PR do?
write_catalogand subfunctions write out weights as correlation squared. While this is documented it is only documented in one place. This PR adds an option to output weights as raw correlations and slightly more relevant documentation for this.Why was it initiated? Any relevant Issues?
No known issues, but users have been surprised to see correlation squared weights.
PR Checklist
developbase branch selected?CHANGES.md.- [ ] First time contributors have added your name toCONTRIBUTORS.md.