The bitfield package provides tools to record analytic and algorithmic meta data or just any ordinary values to store in a bitfield. A bitfield accompanies a (modelled) dataset and can give insight into data quality, provenance, and intermediate values, or can be used to store output values in a highly compressed form.

Details

The general workflow consists of defining a registry, growing it by using the required bitfield operators, putting everything together to a bitfield, encoding this into an integer value that can be stored and published, or decoded and re-used in a downstream application.

Operators have four distinct types, based on the flags they grow.

  • binary operators, such as bf_na grow binary flags that encode yes/no decisions,

  • case operators, such as bf_case grow flags that have one less values than there are cases to encode,

  • count operators, such as bf_length grow flags that encode the count integers and

  • numeric operators, such as bf_numeric grow binary floating point flags according to the given precision of the floating point encoding (for example 32 for single precision floating point values).

Author

Maintainer, Author: Steffen Ehrmann steffen.ehrmann@posteo.de