bf_protocol: Define a new bit-flag protocol

In bitfield: Handle Bitfields to Record Meta Data

Define a new bit-flag protocol

Description

Define a new bit-flag protocol

Usage

bf_protocol(
  name,
  description,
  test,
  example,
  type,
  bits = NULL,
  version = NULL,
  extends = NULL,
  note = NULL,
  author = NULL
)

Arguments

name	character(1) simple name of this protocol.
description	character(1) formalised description of the operation in this protocol. It will be parsed with glue and used in the bitfield legend, so can include the test arguments as enbraced expressions.
test	function(...) the function used to build the bit flag.
example	list(.) named list that contains all arguments in test as name with values of the correct type.
type	character(1) the encoding type according to which the bit flag is determined. Possible values are bool (for binary flags), enum (for cases), int (for integers) and num (for floating-point encoding).
bits	integer(1) in case the flag requires more bits than the data in example indicate, provide this here.
version	character(1) the version of this protocol according to the semantic versioning specification, i.e., of the form X.Y.Z, where X is a major version, Y is a minor version and Z is a bugfix. For additional details on when to increase which number, study this website.
extends	character(1) optional protocol name and version that is extended by this protocol.
note	character(1) note on what the extension adds/modifies.
author	person(.) to attach a reference to this protocol, please provide here the relevant information about the author(s). If this is not provided, the author "unknown" will be used.

Value

list containing bit-flag protocol

Examples

newFlag <- bf_protocol(name = "na",
                       description = "{x} contains NA-values{result}.",
                       test = function(x) is.na(x = x),
                       example = list(x = bf_tbl$commodity),
                       type = "bool")

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