NiMARE icon indicating copy to clipboard operation
NiMARE copied to clipboard

Incorporate Estimator and Corrector descriptions into MetaResult objects

Open tsalo opened this issue 3 years ago • 2 comments

Closes #690.

Changes proposed in this pull request:

  • Add a description parameter and attribute to the MetaResult class.
  • Draft descriptions for ALE, ALESubtraction, SCALE, MKDADensity, KDA, MKDAChi2, Fishers, Stouffers, DerSimonianLaird, Hedges, SampleSizeBasedLikelihood, VarianceBasedLikelihood, and WeightedLeastSquares Estimators, as well as FWECorrector and FDRCorrector Correctors.
    • If we do move forward with this, I would love to get input on the descriptions.
  • Draft descriptions for kernel transformers as well.
  • Add a bibtex attribute to the MetaResult class with the references from the description only.

To do/open questions:

  • [ ] Review new descriptions.
    • I would love input from anyone with expertise in any of the methods on the best way to describe each (especially the IBMA estimators).
  • [x] Replace workflow boilerplates with the new Estimator/Corrector descriptions.
  • [x] Do we want to create Dataset descriptions? Do we want to describe the Datasets within the Estimator descriptions?
    • I think we might want to do the latter, since Datasets' relevant elements depend on the analyses being done. However, the drawback is that there are often elements we might want to report outside of the analysis parameters (e.g., total sample sizes in MKDA Estimators, where sample size is not directly used).

tsalo avatar Jun 20 '22 20:06 tsalo

I'm not sure how to extract relevant BibTeX references from the appropriate bib file, but I'd love to incorporate that into the MetaResults.

UPDATE: It's working now!

tsalo avatar Jun 21 '22 14:06 tsalo

Codecov Report

Patch coverage: 91.02% and project coverage change: +0.19 :tada:

Comparison is base (c30add5) 88.85% compared to head (780cab3) 89.05%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #724      +/-   ##
==========================================
+ Coverage   88.85%   89.05%   +0.19%     
==========================================
  Files          39       39              
  Lines        4405     4603     +198     
==========================================
+ Hits         3914     4099     +185     
- Misses        491      504      +13     
Impacted Files Coverage Δ
nimare/base.py 84.52% <ø> (ø)
nimare/dataset.py 89.57% <ø> (ø)
nimare/workflows/macm.py 21.95% <0.00%> (-3.05%) :arrow_down:
nimare/estimator.py 84.84% <80.00%> (-1.82%) :arrow_down:
nimare/meta/kernel.py 94.49% <85.71%> (-1.30%) :arrow_down:
nimare/meta/cbma/ale.py 95.79% <90.90%> (-0.83%) :arrow_down:
nimare/utils.py 95.53% <95.52%> (-0.01%) :arrow_down:
nimare/correct.py 94.59% <100.00%> (+0.20%) :arrow_up:
nimare/meta/cbma/base.py 96.10% <100.00%> (+0.09%) :arrow_up:
nimare/meta/cbma/mkda.py 98.83% <100.00%> (+0.07%) :arrow_up:
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Jun 21 '22 14:06 codecov[bot]

I've made the requested changes. I realized it might take a bit of effort to append the copyright waiver to the boilerplate in the workflow functions, so I'd rather not add that in this PR.

tsalo avatar Feb 02 '23 21:02 tsalo

Thanks!

tsalo avatar Mar 14 '23 20:03 tsalo

great work @tsalo!

jdkent avatar Mar 14 '23 21:03 jdkent