bru_comp_env_extra: Get/set component environment data

In inlabru: Bayesian Latent Gaussian Modelling using INLA and Extensions

Get/set component environment data

Description

Get or set data in the component's env_extra and env environments. If name is NULL, the entire environment is returned.

Usage

bru_comp_env_extra(x, name = NULL)

bru_comp_env_extra(x, name) <- value

bru_comp_env(x, name = NULL)

bru_comp_env(x, name) <- value

Arguments

x	A bru_comp object
name	The name of the variable to get or set. Names prefixed by "BRU_" are reserved for internal use and should not be set by users or external package authors.
value	The value to set for name in env_extra (for the setter function).

Value

For the getter, either the entire environment or the value of name in the environment. For the setters, the modified bru_comp object.

Functions

• bru_comp_env_extra(x, name) <- value: Set data in the component's env_extra environment

• bru_comp_env(): Get the component's env environment, or an element from that environment. Note that in most cases this environment is the global R environment.

• bru_comp_env(x, name) <- value: Set data in the component's env environment. Note that in most cases this environment is the global R environment, so modifying it is normally not recommended.

See Also

bru_comp

Examples

if (bru_safe_inla()) {
  cmp <- bru_comp("x", x)
  as.list(bru_comp_env_extra(cmp))

  cmp <- bru_comp("x", x, model = "fixed")
  as.list(bru_comp_env_extra(cmp))

  bru_comp_env(cmp)
}

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