basic_stats: Give Basic Statistical Information About the Model Results

View source: R/summary-basic-stats.R

basic_statsR Documentation

Give Basic Statistical Information About the Model Results

Description

Return a data.frame containing summary statistics of bpfit model. The summary statistics included are mean, median, standard deviation, lower confidence interval, and upper confidence interval.

Usage

basic_stats(
  model,
  exclude_vars = c("__$", "lprior"),
  l_ci = 0.025,
  u_ci = 0.975
)

Arguments

model

brms::brmsfit object

exclude_vars

list of regular expressions to match what variables to exclude.

l_ci

numeric unit of the lower confidence interval

u_ci

numeric unit of the upper confidence interval

Value

tibble::tibble() object.

Examples

## Not run: 
  BayesPharma::basic_stats(
    model = my_sigmoid_model,
    l_ci = 0.025,
    u_ci = 0.975)

## End(Not run)


maomlab/BayesPharma documentation built on Aug. 24, 2024, 8:45 a.m.