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
Add reports
module
#802
Add reports
module
#802
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #802 +/- ##
==========================================
+ Coverage 87.82% 88.33% +0.50%
==========================================
Files 43 46 +3
Lines 5643 5931 +288
==========================================
+ Hits 4956 5239 +283
- Misses 687 692 +5
☔ View full report in Codecov by Sentry. |
It will be difficult to combine |
I also noticed that when the heatmap is rendered before
given that |
what does the actual html file look like? I'm curious if different versions of the javascript library can be loaded at different sections of the html file. |
I think this is now ready for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @JulioAPeraza, this is looking awesome! Just want to make sure we aren't working with a combinatorial explosion of parameters when specifying default.yml
.
nimare/reports/default.yml
Outdated
- bids: {value: z, corr: FDR, method: indep, suffix: fig-summary} | ||
- bids: {value: z, corr: FDR, method: indep, suffix: figure-non} | ||
- bids: {value: z, corr: FDR, method: indep, suffix: figure-interactive} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just so I understand correctly, FDR
, 'indep` are just defaults, there is no particular reason why these defaults were chosen, correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We chose this combination for the documentation because the FWE montecarlo takes a long time to run with 1000 iterations. The reports function is going to show whatever it finds in the MetaResult object.
nimare/reports/default.yml
Outdated
subtitle: "Label map: negative tail" | ||
- bids: {value: z, corr: FDR, method: indep, diag: FocusCounter, tab: counts, suffix: figure} | ||
subtitle: FocusCounter | ||
caption: *heatmap_text |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you need to enumerate every potential combination of parameters? what would need to be added here if we were to add a new corrector/diagnostic?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you need to enumerate every potential combination of parameters?
Yeah, that's very inefficient, but I couldn't figure out a good way to perform the combinations, like we do with the OS distributions and Python versions during testing.
what would need to be added here if we were to add a new corrector/diagnostic?
We would need to add new bids
variables with all their possible combinations.
nimare/reports/default.yml
Outdated
each cluster in the thresholded map. There is one row for each experiment, and | ||
one column for each cluster, with column names being | ||
<em>PostiveTail</em>/<em>NegativeTail</em> indicating | ||
the sign (+/-) of the cluster's statistical values" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should mention that we re-order the columns and rows so they form clusters in the heatmap
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes look good to me! Great work, default.yml looks way more maintainable, we will tackle any incompatibilities when we come around to supporting some pairwise estimators and image based meta-analyses.
Closes #773.
Changes proposed in this pull request: