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.

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

Chatterjee coefficient #383

Merged
merged 10 commits into from
Aug 1, 2024
Merged

Chatterjee coefficient #383

merged 10 commits into from
Aug 1, 2024

Conversation

kahaaga
Copy link
Member

@kahaaga kahaaga commented Jul 31, 2024

Implements the feature requested in #379.

Changes related to feature

  • Incremented minor version to 4.1.
  • Added changelog entry.
  • Implemented ChatterjeeCorrelation association measure.
  • Implemented SurrogateAssociationTest dispatch for the measure, which shuffles the first variable.
  • Added documentation entry. The docs are here.
  • Added reference to the measure in the association measure/estimator tables.
  • Examples: Example 1: computing the Chatterjee coefficient for independent/dependent variables. Example 2: using a SurrogateAssociationTest to test the significance of association.
  • Tests: comparison to the original authors R-package implementation (in the case of no ties). For the tied case, we can't compare directly, because the R-package doesn't have an y way of controlling the randomisation step. I also verify correctness by testing p-values with a SurrogateAssociationTest.

Other changes

  • Updated changeling with new package name and version.
  • Updated badges in readme.md.

@codecov-commenter
Copy link

codecov-commenter commented Jul 31, 2024

Codecov Report

Attention: Patch coverage is 97.46835% with 2 lines in your changes missing coverage. Please review.

Project coverage is 94.87%. Comparing base (4f1cf39) to head (1ce2621).

Files Patch % Lines
src/methods/correlation/chatterjee.jl 97.01% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #383      +/-   ##
==========================================
+ Coverage   94.80%   94.87%   +0.06%     
==========================================
  Files         106      108       +2     
  Lines        3024     3103      +79     
==========================================
+ Hits         2867     2944      +77     
- Misses        157      159       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kahaaga kahaaga merged commit 8d1c2e4 into main Aug 1, 2024
2 checks passed
@kahaaga kahaaga deleted the chatterjee_coefficient branch August 1, 2024 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants