brms (version 0.3.0)

brm.pars: Parameters of interest for brms models

Description

Parameters of interest for brms models

Usage

brm.pars(formula, data = NULL, family = "gaussian", autocor = NULL,
  partial = NULL, threshold = "flexible", predict = FALSE, ranef = TRUE,
  engine = "stan", ...)

Arguments

formula

An object of class "formula" (or one that can be coerced to that class): a symbolic description of the model to be fitted. The details of model specification are given under 'Details'.

data

An optional data frame, list or environment (or object coercible by as.data.frame to a data frame) containing the variables in the model. If not found in data, the variables are taken from environment(formula), typically the e

family

A vector of one or two character strings. The first string indicates the distribution of the dependent variable (the 'family'). Currently, the following families are supported: "gaussian", "student", "cauchy",

autocor

An optional cor.brms object describing the correlation structure within the response variable (i.e. the 'autocorrelation'). See the documentation of cor.brms

partial

A one sided formula of the form ~partial.effects specifing the predictors that can vary between categories in non-cumulative ordinal models (i.e. in families "cratio", "sratio", or "acat").

threshold

A character string indicating the type of thresholds (i.e. intercepts) used in an ordinal model. "flexible" provides the standard unstructured thresholds and "equidistant" restricts the distance between consecutive thresholds to

predict

A flag to indicate if posterior predictives of the dependent variable should be generated.

ranef

logical; indicating if random effects estimates should be returned

engine

A character string, either "stan" (the default) or "jags". Specifies which program should be used to fit the model. Note that jags is currently implemented for testing purposes only, does not allow full functionalit

...

Further arguments to be passed to Stan.

Value

• A vector of character strings specifying parameters of interest for models produced by the brms package.

Examples

brm.pars(rating ~ treat + period + carry + (1|subject),
         data = inhaler, family = "cumulative")