Skip to contents

Specify a random effect

re.Rd

This function is meant to be called only in the formula argument of fibre().

Usage

re(
  groups,
  hyper = list(prec = list(prior = "pc.prec", param = c(1, 0.1))),
  label = NULL,
  standardise = TRUE
)

Arguments

groups

A character or factor column containing the grouping variable for the random effect

hyper

Hyper parameters as a list. Specify the prior distribution for engine = INLA models here. Default is a penalised complexity prior with 10% prior probability density greater than 1, which tend to work well for standardised Gaussian responses and Binomial responses.

label

An optional label used to identify the random effect later The default is a label generated from the expression in phyf

standardise

Should the pfc object be standardised based on it's implied typical variance for terminal nodes? Default: TRUE. This helps random effects to be comparable to each other.

Value

A list of data to be used by the model.