This function creates an item for a named variable within
the flags entry in the object's metadata slot.
The purpose is both to document a flag scheme
and to make it so that initializeFlags
and setFlags can specify flags by
name, in addition to number. A generic function, it is
specialized for some classes via interpretation of the
scheme argument (see “Details”, for those
object classes that have such specializations).
initializeFlags(object, name = NULL, value = NULL, debug = 0)An oce object.
Character value indicating the name of a variable within the
data slot of object.
Numerical or character value to be stored in the newly-created
entry within flags. (A character value will only work if
initializeFlags has been used first on object.)
Integer set to 0 for quiet action or to 1 for some debugging.
An object with the flags item within the
metadata slot set up as indicated.
This function was added in early May, 2018, and is likely to undergo changes until the mid-summer of that year. Use with caution.
If object already contains a flags entry with
the indicated name, then it is returned unaltered, and a warning
is issued.
Other functions relating to data-quality flags: defaultFlags,
handleFlags,adp-method,
handleFlags,argo-method,
handleFlags,ctd-method,
handleFlags,section-method,
handleFlags,
initializeFlagScheme,ctd-method,
initializeFlagScheme,oce-method,
initializeFlagScheme,section-method,
initializeFlagScheme,
initializeFlags,adp-method,
initializeFlags,oce-method,
setFlags,adp-method,
setFlags,ctd-method,
setFlags,oce-method, setFlags