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

Add "summary" method to Results classes #105

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Jun 3, 2022

References #5, but doesn't close it because I don't know what to do for plotting.

Changes proposed:

  • Create MetaRegressionResults.summary(), modeled after metafor's rma results __repr__ (or whatever it's called in R).

To do:

  • Review outputs and check their correctness
  • PermutationTestResults
  • CombinationTestResults

@tsalo tsalo added the enhancement New feature or request label Jun 3, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jun 3, 2022

Codecov Report

Merging #105 (f82482a) into master (f425ff9) will decrease coverage by 0.07%.
The diff coverage is 85.18%.

@@            Coverage Diff             @@
##           master     #105      +/-   ##
==========================================
- Coverage   87.60%   87.52%   -0.08%     
==========================================
  Files          13       13              
  Lines         863      890      +27     
==========================================
+ Hits          756      779      +23     
- Misses        107      111       +4     
Impacted Files Coverage Δ
pymare/utils.py 75.00% <60.00%> (-25.00%) ⬇️
pymare/results.py 83.91% <100.00%> (+1.28%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f425ff9...f82482a. Read the comment docs.

@tsalo
Copy link
Member Author

tsalo commented Jun 8, 2022

I'm not sure what the CombinationTestResults summary should look like given the limited results, and PermutationTestResults's summary would depend on the parent Results type.

I almost think that we should remove PermutationTestResults completely, and just stick with the other two objects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants