wwiecek / baggr

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

use hypermean(), hypersd() to refer to treatment_effects() #145

Closed wwiecek closed 8 months ago

wwiecek commented 2 years ago

Currently treatment_effects typically returns a list of length two, first element is the hypermean and the second element is hyper-SD. (For more complicated models this may change, but for the typical models we have now this holds.)

Add functions hypermean() and hypersd() which work like treatment_effects()[[1]] and [[2]] respectively, then change the package syntax (code of functions), documentation, examples etc. to make use of these shorthands.

treatment_effects should still work going forward and in some cases it makes more sense to keep it (e.g. if you want to use both [[1]] and [[2]])