Build a bit flag by comparing a column with a set

bf_match(
  x,
  test,
  set,
  negate = FALSE,
  pos = NULL,
  na.val = NULL,
  description = NULL,
  registry = NULL
)

Arguments

x: data.frame(1)
the table that contains test.
test: character(1)
the column in x for which a match is checked.
set: a vector of the same class as in test against which a set operation is performed.
negate: logical(1)
whether or not to determine a subset or a disjoint match.
pos: integerish(.)
the position(s) in the bitfield that should be set.
na.val: character(1)
optional value that should be used to substitute NA values in the input data.
description: character(.)
optional description that should be used instead of the default function-specific description. This description is used in the registry legend, so it should have as many entries as there will be entries per the respective flag in the legend (two for a binary flag, as many as there are cases for a cases flag and one for count or numeric flags).
registry: registry(1)
a bitfield registry that has been defined with bf_registry; if it's undefined, an empty registry will be defined on-the-fly.

Value

an object of class 'registry' with the additional flag defined here.

Examples

bf_match(x = tbl_bityield, test = "commodity", set = c("soybean", "maize"))
#>   width 1
#>   flags 1  -
#> 
#>   pos   encoding type   col
#>   1     0.0.1/0  match  commodity