wwiecek / baggr

R package for Bayesian meta-analysis models, using Stan
GNU General Public License v3.0
48 stars 12 forks source link

in baggr() arguments, Don't say `effect` say `label` #150

Closed wwiecek closed 11 months ago

wwiecek commented 1 year ago

Right now I'd write e.g.

bg <- baggr(schools, effect = "mean SAT score")

to label the results when printing and plotting. It's returned as bg$effect. But effect is misleading. I prefer

baggr(schools, label = "mean SAT score")

and to refer to it as bg$label. However, when implementing this, for compatibility sake, if someone passes an effect argument, it should be turned into label (even if effect is no longer a documented argument into the function) and a prompt like "Going forward please use "label" instead of "effect" should be issued