Skip to contents

Extract predictor index information

Source: R/bru.inference.R
bru_index.Rd

[Experimental] 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_like'
bru_index(object, what = NULL, ...)

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

Arguments

object

A bru() or bru_obs() output object

...

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.

Value

An integer vector.

Methods (by class)

  • bru_index(bru_like): 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.

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)
#> [1] 1 2 3 4 5 6 7
bru_index(fit, "A")
#> [1] 1 2 3
bru_index(fit, "B")
#> [1] 4 5 6 7
bru_index(fit, c("B", "A"))
#> [1] 4 5 6 7 1 2 3
bru_index(fit, what = "missing")
#> [1] 4 5