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
Change names of interval columns in augment() for clarity #925
Conversation
modeltests needs an update to the column_glossary
Thanks for making this happen! I'm feeling positive about how this came together with respect to the first bullet. I dropped a comment in about the second. Could you ensure that changes have been made only to relevant documentation? Quite a few |
This reverts commit 34257b4.
…ction to .pred.low/.pred.high The columns previously labeled "cr.lb" and "cr.ub" in rma objects are now called "pi.lb" and "pi.ub". The previous label was misleading and inaccurate--these values are not "credibility intervals" as used in the meta-analysis literature or "credible intervals" as used in Bayesian analysis. They are prediction intervals ala lm(). The change in metafor was to avoid some common confusion and misinterpretation among metafor users; this change to "pred" instead of "cred" follows suit.
I've reverted the documentation entirely. When I try to run devtools::document(), it doesn't seem to be producing the correct output (e.g., the Value table disappears entirely for agument.rma; and the Value table for augment.lm is missing the interval arguments). I think this has to do with the (The other files being modified was that some of the .Rd files seem out of sync with the roxygen templates.) |
That's fine.👍 The other modified files are a result of differences in package versions. Recent switch in how documentation gets linked from place to place that can be a pain in package dev. |
Only return one interval for the few metafor results that return both by default.
Great, much appreciated! There are some I'm feeling positive about where this is at. Looping you in, @alexpghayes. |
I’ll take a look tomorrow afternoon. |
@simonpcouch The example errors are just because the documentation Rd is out of sync with the roxygen. In the roxygen, all of the ggplot calls refer to |
@simonpcouch Did you want me to change anything regarding those errors or is this fine for now? |
Oh, gotcha! No worries on the errors, then. Thanks for checking in. |
Thanks for your patience! Alex and I finally had a chance to talk on this, and we're game. Thanks for the contribution. Will go ahead and fix conflicts and then merge. |
Thanks so much! Glad it got merged! |
This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue. |
Closes #921
.conf.low
to.lower
and.conf.high
to.upper
consistently foraugment()
output.agument.rma()
to consistently return one set of intervals.