Skip to contents

Methods for inlabru component lists

Source: R/effect.R
bru_comp_list.Rd

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

Usage

bru_comp_list(object, lhoods = NULL, .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_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

lhoods

A bru_obs_list object

.envir

An evaluation environment for non-formula input

...

Parameters passed on to other methods. Also see Details.

inputs

A tree-like list of component input evaluations, from input_eval.bru_obs_list().

x

bru_comp_list object from which to extract a sub-list

i

indices specifying elements to extract

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 and/or component formulas into a bru_comp_list object

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.

See also

Other component constructors: bru_comp()

Other component constructors: bru_comp()

Author

Fabian E. Bachl bachlfab@gmail.com and Finn Lindgren finn.lindgren@gmail.com

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]])
#> Label:	myLinearEffectOfX
#>   Type:	main = linear, group = exchangeable, replicate = iid
#>   Input:	main = x, group = 1L, replicate = 1L, NULL
#>   Map: Not yet initialised
#>   INLA formula:	
#>     ~ . + f(myLinearEffectOfX, model =
#>       BRU_myLinearEffectOfX_main_model)
# 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")