Skip to contents

Define all pairwise variable combinations

Source: R/define-var-ids.R
pairwise.Rd

pairwise() creates a pairwise Variable Mapper from a set of variables, producing all unique variable pairs. Use direction to control which pairs are retained. Pairs are filtered by lexicographic (alphabetical) ordering of variable names.

Usage

pairwise(..., direction = "lt")

Arguments

...

Bare variable names, tidyselect helpers (requires data in define_model()), or I(expr) for inline data.

direction

A string controlling which pairs are kept:

  • "lt" (default): strict lower triangle, i.e. pairs where index(x) < index(y)

  • "lteq": lower triangle including the diagonal (x <= y)

  • "gt": strict upper triangle (x > y)

  • "gteq": upper triangle including the diagonal (x >= y)

  • "eq": diagonal only (x == y), i.e. each variable paired with itself

  • "neq": all pairs except the diagonal (x != y)

  • "all": all combinations including both directions and the diagonal

Value

A pairwise / var_id S7 object.

Examples

pairwise(a, b, c)
#> -- Model Definition ------------------------------------------------------------ 
#> 
#> Variable Mapper : pairwise 
#> Args : a, b, c 

# Inline data
pairwise(I(rnorm(30)), I(rnorm(30)), I(rnorm(30)))
#> -- Model Definition ------------------------------------------------------------ 
#> 
#> Variable Mapper : pairwise 
#> Args : <inline>, <inline>, <inline> 

# Keep all ordered pairs
pairwise(a, b, c, direction = "all")
#> -- Model Definition ------------------------------------------------------------ 
#> 
#> Variable Mapper : pairwise 
#> Args : a, b, c