bru_used_vars: Extract basic variable names from expression

View source: R/bru.inference.R

bru_used_varsR Documentation

Extract basic variable names from expression

Description

Extracts the variable names from an R expression by pre- and post-processing around all.vars(). First replaces $ with [[ indexing, so that internal column/variable names are ignored, then calls all.vars().

Usage

bru_used_vars(x, functions = FALSE)

## S3 method for class 'character'
bru_used_vars(x, functions = FALSE)

## S3 method for class 'expression'
bru_used_vars(x, functions = FALSE)

## S3 method for class 'formula'
bru_used_vars(x, functions = FALSE)

Arguments

x

A formula, expression, or character

functions

logical; if TRUE, include function names

Value

If successful, a character vector, otherwise NULL

Methods (by class)

  • bru_used_vars(formula): Only the right-hand side is used.

See Also

Other bru_used: bru_used(), bru_used_update()

Examples

bru_used_vars(~.)
bru_used_vars(~ a + b + c_latent + d_eval())
bru_used_vars(expression(a + b + c_latent + d_eval()))

bru_used_vars(~., functions = TRUE)
bru_used_vars(~ a + b + c_latent + d_eval(), functions = TRUE)
bru_used_vars(expression(a + b + c_latent + d_eval()), functions = TRUE)

bru_used_vars(a ~ b)
bru_used_vars(expression(a ~ b))


inlabru-org/inlabru documentation built on April 25, 2024, 2:43 p.m.