bru_used {inlabru} | R Documentation |
List components used in a model
Description
Create or extract information about which components are used by a model, or
its individual observation models. If a non-NULL labels
argument is
supplied, also calls bru_used_update()
on the bru_used
objects.
Usage
bru_used(x = NULL, ...)
## Default S3 method:
bru_used(
x = NULL,
...,
effect = NULL,
effect_exclude = NULL,
latent = NULL,
labels = NULL
)
## S3 method for class 'character'
bru_used(
x,
...,
effect = NULL,
effect_exclude = NULL,
latent = NULL,
labels = NULL
)
## S3 method for class 'expression'
bru_used(
x,
...,
effect = NULL,
effect_exclude = NULL,
latent = NULL,
labels = NULL
)
## S3 method for class 'formula'
bru_used(
x,
...,
effect = NULL,
effect_exclude = NULL,
latent = NULL,
labels = NULL
)
## S3 method for class 'bru'
bru_used(x, ..., join = TRUE)
## S3 method for class 'list'
bru_used(x, ..., join = TRUE)
## S3 method for class 'bru_like'
bru_used(x, ...)
## S3 method for class 'bru_used'
bru_used(x, labels = NULL, ...)
## S3 method for class 'bru_used'
format(x, ...)
## S3 method for class 'bru_used'
summary(object, ...)
## S3 method for class 'bru_used'
print(x, ...)
Arguments
x |
An object that contains information about used components |
... |
Parameters passed on to the other methods |
effect |
character; components used as effects. When |
effect_exclude |
character; components to specifically exclude from
effect evaluation. When |
latent |
character; components used as |
labels |
character; component labels passed on to
|
join |
Whether to join list output into a single object; Default may depend on the input object class |
Value
A bru_used
object (a list with elements effect
and latent
), or a list of such objects
(for methods with join = FALSE
)
Methods (by class)
-
bru_used(default)
: Create abru_used
object. -
bru_used(character)
: Create abru_used
object from acharacter
representation of an expression. -
bru_used(expression)
: Create abru_used
object from an expression object. -
bru_used(formula)
: Create abru_used
object from a formula (only the right-hand side is used). -
bru_used(bru_used)
: Convenience method that takes an existingbru_used
object and callsbru_used_update()
iflabels
is non-NULL.
Methods (by generic)
-
format(bru_used)
: Text formatting method forbru_used
objects. -
summary(bru_used)
: Summary method forbru_used
objects. -
print(bru_used)
: Print method forbru_used
objects.
See Also
Other bru_used:
bru_used_update()
,
bru_used_vars()
Examples
(used <- bru_used(~.))
bru_used(used, labels = c("a", "c"))
(used <- bru_used(~ a + b + c_latent + d_latent))
bru_used(used, labels = c("a", "c"))
(used <- bru_used(expression(a + b + c_latent + d_latent)))
bru_used(used, labels = c("a", "c"))