bf_decode: Decode (unpack) a bitfield

In bitfield: Handle Bitfields to Record Meta Data

Decode (unpack) a bitfield

Description

This function takes an integer bitfield and the registry used to build it upstream to decode it into bit representation and thereby unpack the data stored in the bitfield.

Usage

bf_decode(x, registry, flags = NULL, sep = NULL, verbose = TRUE)

Arguments

x	integerish(1) table of the integer representation of the bitfield.
registry	registry(1) the registry that should be used to decode the bitfield.
flags	character(.) the name(s) of flags to extract from this bitfield; leave at NULL to extract the full bitfield.
sep	character(1) a symbol with which, if given, the distinct fields shall be separated.
verbose	logical(1) whether or not to return the registry legend.

Value

data.frame with the binary values of flags in the registry in columns.

Examples

# build registry
reg <- bf_map(protocol = "na", data = bf_tbl, x = commodity)
reg <- bf_map(protocol = "matches", data = bf_tbl, x = commodity, set = c("soybean", "maize"),
              registry = reg)
reg

# encode the flags into a bitfield
field <- bf_encode(registry = reg)
field

# decode (somewhere downstream)
flags <- bf_decode(x = field, registry = reg, sep = "-")
flags

# more reader friendly
cbind(bf_tbl, bf_decode(x = field, registry = reg, verbose = FALSE))

bitfield documentation built on June 9, 2025, 5:09 p.m.