get_est {hbamr} | R Documentation |
Extract point estimates or other summaries of marginal posterior distributions
Description
For objects produced by hbam()
, this function is a wrapper for rstan::summary()
. For objects produced by fbam()
it offers a way to extract point estimates.
Usage
get_est(
object,
par = "theta",
format_orig = FALSE,
probs = c(0.025, 0.5, 0.975),
simplify = TRUE,
...
)
Arguments
object |
An instance of class |
par |
Character: Name of the parameter type to be extracted. Typically |
format_orig |
Logical: Should individual-level parameters be mapped to the original dataset by returning rows of NAs for respondents who were not included in the analysis? Defaults to |
probs |
A numeric vector of quantiles of interest for summarizing |
simplify |
Logical: Should the returned object be simplified by dropping the Monte Carlo standard error and the posterior standard deviation? Defaults to |
... |
Other arguments are passed on to |
Value
A tibble containing summaries of marginal posterior distributions. For objects produced by fbam()
, only maximum a posteriori estimates are returned.