This function changes specified entries in the data-quality
flags of a oce object, which are stored within
a list named flags that resides in the metadata
slot. If the object already has a flag set up for name,
then only the specified entries are altered. If not, the flag
entry is first created and its entries set to default,
after which the entries specified by i
are changed to value.
The specification is made with i, the form of which
is determined by the data item in question. Generally,
the rules are as follows:
If the data item is a vector, then i must be (a)
an integer vector specifying indices to be set to value,
(b) a logical vector of length matching the data item, with
TRUE meaning to set the flag to value, or (c)
a function that takes an oce object as its single
argument, and returns a vector in either of the forms
just described.
If the data item is an array, then i must be
(a) a data frame of integers whose rows specify spots to change
(where the number of columns matches the number of dimensions
of the data item), (b) a logical array that has dimension equal to
that of the data item, or (c) a function that takes an oce
object as its single input and returns such a data frame or array.
See “Details” for the particular case of
oce-class objects.
# S4 method for oce
setFlags(object, name = NULL, i = NULL, value = NULL,
debug = getOption("oceDebug"))An oce object.
Character string indicating the name of the variable to be flagged. If
this variable is not contained in the object's data slot, an error is reported.
Indication of where to insert the flags; see “Description” for
general rules and “Details” for rules for oce-class
objects.
The value to be inserted in the flag.
Integer set to 0 for quiet action or to 1 for some debugging.
An object with flags set 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.
This generic function is overridden by specialized functions for some object classes.
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,
initializeFlagSchemeInternal,
initializeFlagScheme,
initializeFlags,adp-method,
initializeFlags,oce-method,
initializeFlagsInternal,
initializeFlags,
setFlags,adp-method,
setFlags,ctd-method, setFlags