bru_index: Extract predictor or component index information

In inlabru-org/inlabru: Bayesian Latent Gaussian Modelling using INLA and Extensions

Extract predictor or component index information

Description

Extract the index vector for a bru_obs() predictor, or the whole or a subset of a full bru() predictor.

Usage

bru_index(object, ...)

## S3 method for class 'bru_obs'
bru_index(object, what = NULL, ...)

## S3 method for class 'bru'
bru_index(object, tag = NULL, what = NULL, ...)

## S3 method for class 'bru_comp'
bru_index(object, inla_f, ...)

## S3 method for class 'bru_comp_list'
bru_index(object, inla_f, ...)

## S3 method for class 'bru_model'
bru_index(object, used, ...)

index_eval(...)

Arguments

object	A component.
...	Arguments passed on to sub-methods.
what	character or NULL; One of NULL, "all", "observed", and "missing". If NULL (default) or "all", gives the index vector for the full sub-model predictor. If "observed", gives the index vector for the observed part (response is not NA). If "missing", gives the index vector for the missing part (response is NA) of the model.
tag	character or integer; Either a character vector identifying the tags of one or more of the bru_obs() observation models, or an integer vector identifying models by their bru() specification order. If NULL (default) computes indices for all sub-models.
inla_f	logical; when TRUE, must result in values compatible with INLA::f(...) an specification and corresponding INLA::inla.stack(...) constructions.
used	A bru_used() object

Value

• bru_index(bru_obs): An integer vector.

• bru_index(bru): An integer vector.

• bru_index(bru_comp): A list of indices into the latent variables compatible with the component mapper.

• bru_index(bru_comp_list): A list of list of indices into the latent variables compatible with each component mapper.

• bru_index(bru_model): A named list of idx_full and idx_inla, named list of indices, and inla_subset, and inla_subset, a named list of logical subset specifications for extracting the INLA::f() compatible index subsets.

Methods (by class)

• bru_index(bru_obs): Extract the index vector for the predictor vector for a bru_obs() sub-model. The indices are relative to the sub-model, and need to be appropriately offset to be used in the full model predictor.

• bru_index(bru): Extract the index vector for "APredictor" for one or more specified observation bru_obs() sub-models. Accepts any combination of tag and what.

• bru_index(bru_model): Compute all index values for a bru_model() object. Computes the index value matrices for included components according to the used argument.

Functions

• index_eval(): since "2.12.0.9023". Use bru_index() instead.

Author(s)

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

Examples

fit <- bru(
  ~ 0 + x,
  bru_obs(
    y ~ .,
    data = data.frame(x = 1:3, y = 1:3 + rnorm(3)),
    tag = "A"
  ),
  bru_obs(
    y ~ .,
    data = data.frame(x = 1:4, y = c(NA, NA, 3:4) + rnorm(4)),
    tag = "B"
  )
)
bru_index(fit)
bru_index(fit, "A")
bru_index(fit, "B")
bru_index(fit, c("B", "A"))
bru_index(fit, what = "missing")

inlabru-org/inlabru documentation built on July 17, 2025, 2:11 a.m.