defaultFlags: Suggest a default flag vector for bad or suspicious data

Description Usage Arguments Details Value References See Also

View source: R/AllClass.R

Description

defaultFlags tries to suggest a reasonable default flag scheme for use by handleFlags(). It does this by looking for an item named flagScheme in the metadata slot of object. If flagScheme is found, and if the scheme is recognized, then a numeric vector is returned that indicates bad or questionable data. If flagScheme$default exists, then that scheme is returned. However, if that does not exist, and if flagScheme$name is recognized, then a pre-defined (very conservative) scheme is used, as listed below.

Usage

1
defaultFlags(object)

Arguments

object

An oce object

Details

Value

A vector of one or more flag values, or NULL if object metadata slot lacks a flagScheme as set by initializeFlagScheme(), or if it has a scheme that is not in the list provide in “Description”.

References

See Also

Other functions relating to data-quality flags: handleFlags,adp-method, handleFlags,argo-method, handleFlags,ctd-method, handleFlags,oce-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,oce-method, setFlags()


oce documentation built on March 28, 2021, 9:09 a.m.