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

Clarify FWECorrector arguments #865

Merged
merged 6 commits into from
Jan 19, 2024
Merged

Clarify FWECorrector arguments #865

merged 6 commits into from
Jan 19, 2024

Conversation

adelavega
Copy link
Member

@adelavega adelavega commented Jan 18, 2024

The FWECorrector was written generally, such that methods beyond bonferoni and montecarlo could be specified if an Estimator implements one.

However, as of yet no such alternate method is implemented, and this generic organization obfuscates the API for the FWECorrector, as its not clear what possible options are implmeneted by estimators for monte carlo correction.

Here, I make this API more explicit by:

  • Makes montecarlo and bonferroni only possible options for FWECorrector, instead of any possible yet to defined method
  • Sets n_iters to 5000 across the board (except MKDAChi2)
  • Makes other montecarlo arguments directly available to FWECorrector

Copy link
Member

@jdkent jdkent left a comment

Choose a reason for hiding this comment

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

could n_iters be set in the base_class?

https://github.com/neurostuff/NiMARE/pull/865/files#diff-4cafb2c711a65e5b19450202efbd9250dc086c814fb97588c1fd88afcc1add0cL73-L80

could save having to keep track of the default value in multiple locations

Copy link

codecov bot commented Jan 19, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (efae75e) 88.48% compared to head (98b4bd8) 88.20%.
Report is 6 commits behind head on main.

Files Patch % Lines
nimare/correct.py 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #865      +/-   ##
==========================================
- Coverage   88.48%   88.20%   -0.29%     
==========================================
  Files          48       48              
  Lines        6337     6339       +2     
==========================================
- Hits         5607     5591      -16     
- Misses        730      748      +18     

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

@adelavega adelavega merged commit f414999 into main Jan 19, 2024
20 checks passed
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.

2 participants