bru_comp_list: Methods for inlabru component lists

In inlabru: Bayesian Latent Gaussian Modelling using INLA and Extensions

Methods for inlabru component lists

Description

Constructor methods for inlabru component lists. Syntax details are given in bru_comp().

Usage

bru_comp_list(object, ..., .envir = parent.frame())

## S3 method for class 'formula'
bru_comp_list(object, ..., lhoods = NULL, .envir = parent.frame())

## S3 method for class 'list'
bru_comp_list(
  object,
  ...,
  lhoods = NULL,
  .envir = parent.frame(),
  inputs = NULL
)

## S3 method for class 'bru_comp'
bru_comp_list(object, ..., .envir = parent.frame())

## S3 method for class 'bru_comp_list'
bru_comp_list(object, ..., .envir = parent.frame())

## S3 method for class 'bru_comp_list'
c(...)

## S3 method for class 'bru_comp'
c(...)

## S3 method for class 'bru_comp_list'
x[i]

Arguments

object	The object to operate on
...	Parameters passed on to other methods. Also see Details.
.envir	An evaluation environment for non-formula input
lhoods	A bru_obs_list object
inputs	A tree-like list of component input evaluations, from bru_input.bru_obs_list().
x	bru_comp_list object from which to extract a sub-list
i	indices specifying elements to extract

Value

A bru_comp_list object, which is a named list of bru_comp objects.

Methods (by class)

• bru_comp_list(formula): Convert a component formula into a bru_comp_list object

• bru_comp_list(list): Combine a list of components, component lists, and/or component formulas into a single bru_comp_list object

• bru_comp_list(bru_comp): Place a single bru_comp object into a bru_comp_list object.

• bru_comp_list(bru_comp_list): Make sure a bru_comp_list object is fully configured.

Methods (by generic)

• c(bru_comp_list): The ... arguments should be bru_comp_list objects. The environment from the first argument will be applied to the resulting bru_comp_list.

Functions

• c(bru_comp): The ... arguments should be component objects from bru_comp(). The environment from the first argument will be applied to the resulting bru_comp_list.

Author(s)

Fabian E. Bachl [e-mail] and Finn Lindgren [e-mail]

See Also

Other component constructors: bru_comp()

Examples

# As an example, let us create a linear component. Here, the component is
# called "myLinearEffectOfX" while the covariate the component acts on is
# called "x". Note that a list of components is returned because the
# formula may define multiple components

eff <- bru_comp_list(~ myLinearEffectOfX(main = x, model = "linear"))
summary(eff[[1]])
# Equivalent shortcuts:
eff <- bru_comp_list(~ myLinearEffectOfX(x, model = "linear"))
eff <- bru_comp_list(~ myLinearEffectOfX(x))
# Individual component
eff <- bru_comp("myLinearEffectOfX", main = x, model = "linear")

inlabru documentation built on July 28, 2026, 9:07 a.m.