Access the blueprintr metadata at runtime

annotations(x)

annotation_names(x)

annotation(x, field)

super_annotation(x, field)

has_annotation(x, field)

has_super_annotation(x, field)

add_annotation(x, field, value, overwrite = FALSE)

set_annotation(x, field, value)

add_super_annotation(x, field, value)

remove_super_annotation(x, field)

Arguments

x: An object, most likely a variable in a data.frame
field: The name of a metadata field
value: A value to assign to an annotation field
overwrite: If TRUE, allows overwriting of existing annotation values

Functions

annotations(): Gets a list of all annotations assigned to an object
annotation_names(): Get the names of all of the annotations assigned to an object
annotation(): Gets an annotation for an object
super_annotation(): Gets an annotation that overrides existing annotations
has_annotation(): Checks to see if an annotation exists for an object
has_super_annotation(): Checks to see if an overriding annotation exists for an object
add_annotation(): Adds an annotation to an object, with the option of overwriting an existing value
set_annotation(): Alias to add_annotation(overwrite = TRUE)
add_super_annotation(): Adds an overriding annotation to an object. Note that overriding annotations will overwrite previous assignments!
remove_super_annotation(): Removes overriding annotation