The brms package provides an interface to fit bayesian generalized linear mixed models using Stan, which is a C++ package for obtaining Bayesian inference using the No-U-turn sampler (see http://mc-stan.org/). The formula syntax is very similar to that of the package lme4 to provide a familiar and simple interface for performing regression analyses.
library(brms)As a simple example, we use poisson regression to model the seizure counts in epileptic patients to investigate whether the treatment (represented by variable Trt_c) can reduce the seizure counts. Three random intercepts are incorporated to account for the variance between patients and visits, as well as for the residual variance.
fit <- brm(count ~ log_Age_c + log_Base4_c * Trt_c + (1|patient) + (1|visit) + (1|obs),
data = epilepsy, family = "poisson")
#> Compiling the C++ modelThe results (i.e. posterior samples) can be investigated using
summary(fit)
#> Family: poisson (log)
#> Formula: count ~ log_Age_c + log_Base4_c + Trt_c + (1 | patient) + (1 | visit) + (1 | obs) + log_Base4_c:Trt_c
#> Data: epilepsy (Number of observations: 236)
#> Samples: 2 chains, each with n.iter = 2000; n.warmup = 500; n.thin = 1;
#> total post-warmup samples = 3000
#> WAIC: 1144.7
#>
#> Random Effects:
#> ~obs (Number of levels: 236)
#> Estimate Est.Error l-95% CI u-95% CI Eff.Sample Rhat
#> sd(Intercept) 0.37 0.05 0.28 0.46 1089 1
#>
#> ~patient (Number of levels: 59)
#> Estimate Est.Error l-95% CI u-95% CI Eff.Sample Rhat
#> sd(Intercept) 0.51 0.07 0.37 0.66 899 1
#>
#> ~visit (Number of levels: 4)
#> Estimate Est.Error l-95% CI u-95% CI Eff.Sample Rhat
#> sd(Intercept) 0.11 0.11 0 0.41 747 1
#>
#> Fixed Effects:
#> Estimate Est.Error l-95% CI u-95% CI Eff.Sample Rhat
#> Intercept 1.56 0.10 1.35 1.76 724 1
#> log_Age_c 0.48 0.36 -0.23 1.20 1078 1
#> log_Base4_c 1.07 0.11 0.85 1.27 1211 1
#> Trt_c -0.34 0.16 -0.66 -0.03 1269 1
#> log_Base4_c:Trt_c 0.36 0.22 -0.09 0.78 1046 1
#>
#> Samples were drawn using NUTS(diag_e). For each parameter, Eff.Sample is a
#> crude measure of effective sample size, and Rhat is the potential scale
#> reduction factor on split chains (at convergence, Rhat = 1).On the top of the output, some general information on the model is given, such as family, formula, number of iterations and chains, as well as the WAIC, which is an information criterion for Bayesian models. Next, random effects are displayed seperately for each grouping factor in terms of standard deviations and (in case of more than one random effect per grouping factor; not displayed here) correlations between random effects. On the bottom of the output, fixed effects are displayed. If incorporated, autocorrelation effects and family specific parameters (e.g., the residual standard deviation 'sigma' in normal models) are also given.
In general, every parameter is summarized using the mean ('Estimate') and the standard deviation ('Est.Error') of the posterior distribution as well as two-sided 95% Credible intervals ('l-95% CI' and 'u-95% CI') based on quantiles. The last two values ('Eff.Sample' and 'Rhat') provide information on how well the algorithm could estimate the posterior distribution of this parameter. If 'Rhat' is considerably greater than 1, the algorithm has not yet converged and it is necessary to run more iterations and / or set stronger priors.
To visually investigate the chains as well as the posterior distributions, you can use
plot(fit) An even more detailed investigation can be achieved by applying the shinystan package:
launch_shiny(fit) For a complete list of methods to apply on brms models see
methods(class = "brmsfit")
#> [1] family fitted fixef formula
#> [5] hypothesis launch_shiny logLik LOO
#> [9] ngrps nobs parnames plot
#> [13] posterior_samples predict print prior_samples
#> [17] ranef residuals stancode standata
#> [21] stanplot summary VarCorr vcov
#> [25] WAIC
#> see '?methods' for accessing help and source codeDetails on formula syntax, families and link functions, as well as prior distributions can be found on the help page of the brm function:
help(brm) More instructions on how to use brms are given in the package's vignette.
vignette("brms") To install the latest release version from CRAN use
install.packages("brms")The current developmental version can be downloaded from github via
library(devtools)
install_github("paul-buerkner/brms")Because brms is based on Stan, a C++ compiler is required. The program Rtools (available on https://cran.r-project.org/bin/windows/Rtools/) comes with a C++ compiler for Windows. On Mac, you should use Xcode. For further instructions on how to get the compilers running, see the prerequisites section on https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started.