Parse formula
or brmsformula
objects for use
in brms.
parse_bf(formula, family = NULL, autocor = NULL, check_response = TRUE,
resp_rhs_all = TRUE)
An object of class
formula
or
brmsformula
(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
.
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.
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
.
An object of class brmsterms
, 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.