Parse formulas objects for use in brms.
parse_bf(formula, ...)# S3 method for default
parse_bf(formula, family = NULL, autocor = NULL, ...)
# S3 method for brmsformula
parse_bf(formula, family = NULL, autocor = NULL,
check_response = TRUE, resp_rhs_all = TRUE, mv = FALSE,
rescor = FALSE, ...)
# S3 method for mvbrmsformula
parse_bf(formula, family = NULL, autocor = NULL,
...)
An object of class
formula,
brmsformula, or mvbrmsformula
(or one that can be coerced to that classes):
A symbolic description of the model to be fitted.
The details of model specification are explained in
brmsformula.
Further arguments passed to or from other methods.
A description of the response distribution and link function
to be used in the model. This can be a family function,
a call to a family function or a character string naming the family.
Every family function has a link argument allowing to specify
the link function to be applied on the response variable.
If not specified, default links are used.
For details of supported families see
brmsfamily.
By default, a linear gaussian model is applied.
In multivariate models, family might also be a list of families.
An optional cor_brms object describing
the correlation structure within the response variable
(i.e., the 'autocorrelation').
See the documentation of cor_brms for a description
of the available correlation structures. Defaults to NULL,
corresponding to no correlations.
In multivariate models, autocor might also be a list
of autocorrelation structures.
Logical; Indicates whether the left-hand side
of formula (i.e. response variables and addition arguments)
should be parsed. If FALSE, formula may also be one-sided.
Logical; Indicates whether to also include response
variables on the right-hand side of formula .$allvars,
where . represents the output of parse_bf.
Indicates if the univariate model is part of a multivariate model.
Indicates if residual correlations should be estimated. Only relevant in multivariate models.
An object of class brmsterms or mvbrmsterms
(for multivariate models), which is a list containing all
required information initially stored in formula
in an easier to use format, basically a list of formulas
(not an abstract syntax tree).
This is the main formula parsing function of brms. It should usually not be called directly, but is exported to allow package developers making use of the formula syntax implemented in brms. As long as no other packages depend on this functions, it may be changed without deprecation warnings, when new features make this necessary.