Initiate a new registry

bf_registry(name, description, author = NULL, project = NULL, license = "MIT")

Arguments

name

character(1)
the name of the bitfield.

description

character(1)
the description of the bitfield.

author

person(.)
the author(s) involved in the creation of this registry.

project

list(1)
object created with the function project that documents the project metadata.

license

character(1)
license or rights statement.

Value

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

Examples

auth <- person(given = "Jane", family = "Smith",
               email = "jane@example.com", role = c("cre", "aut"))

proj <- project(title = "example project",
                people = c(person("Jane", "Smith", email = "jane@example.com",
                                  role = "aut"),
                           person("Robert", "Jones", role = c("aut", "cre"))),
                publisher = "example publisher",
                type = "Dataset",
                identifier = "10.5281/zenodo.1234567",
                description = "A comprehensive explanation",
                subject = c("keyword", "subject"),
                license = "CC-BY-4.0")
#> Error: unable to find an inherited method for function ‘project’ for signature ‘x = "missing"’

reg <- bf_registry(name = "currentWorkflow",
                   description = "the registry to my modelling pipeline",
                   author = auth,
                   project = proj)