Initiate a new registry — bf_registry • bitfield

Initiate a new registry

bf_registry(name = NULL, description = NULL)

Arguments

name: character(1)
the name of the bitfield.
description: character(1)
the description of the bitfield.

Value

an empty registry that captures some metadata of the bitfield, but doesn't contain any flags yet.

Details

Besides creating a registry object, this function also opens the environment bf_env, which is used to store the temporary non-encoded flag values.

Examples

reg <- bf_registry(name = "currentWorkflow",
                   description = "this is to document my current workflow so
                                 that I can share it with my colleagues
                                 alongside a publication.")