This class is for data stored in a format used at Canadian
Department of Fisheries and Oceans laboratories. It is somewhat
similar to the bremen-class, in the sense
that it does not apply just to a particular instrument.
dataAs with all oce objects, the data slot
for odf objects is a
list containing the main data for the object.
metadataAs with all oce objects, the metadata slot
for odf objects is a list containing
information about the data or about the object itself.
processingLogAs with all oce objects, the processingLog slot
for odf objects is a
list with entries describing the creation and evolution
of the object. The contents are updated by various oce functions to
keep a record of processing steps. Object summaries and
processingLogShow both display the log.
Although the [[<- operator may permit modification of the contents
of odf objects (see [[<-,odf-method),
it is better to use oceSetData
and oceSetMetadata, because that will save an entry
in the processingLog to describe the change.
The full contents of the data and metadata slots of a odf
object named odf may be retrieved in the standard R way. For example,
slot(odf, "data") and slot(odf, "metadata") return
the data and metadata slots, respectively. The
[[,odf-method operator can also be used to access slots,
with odf[["data"]] and odf[["metadata"]], respectively.
Furthermore, [[,odf-method can be used to retrieve
named items (and potentially some derived items) within the
metadata and data slots, the former taking precedence
over the latter in the lookup. It is also possible
to find items more directly, using oceGetData and
oceGetMetadata, but this cannot retrieve derived items.
[1] Anthony W. Isenor and David Kellow, 2011. ODF Format Specification Version 2.0. (This is a .doc file downloaded from a now-forgotten URL by Dan Kelley, in June 2011.)
[2] The St Lawrence Global Observatory website has information on ODF format at https://slgo.ca/app-sgdo/en/docs_reference/format_odf.html
[3] List of variable codes: https://slgo.ca/app-sgdo/en/docs_reference/code_parametre_odf.html (checked 2018-02-11); only a subset are handled.
Other things related to odf data: ODF2oce,
ODFListFromHeader,
ODFNames2oceNames,
[[,odf-method,
[[<-,odf-method,
plot,odf-method,
read.ctd.odf, read.odf,
subset,odf-method,
summary,odf-method
Other classes provided by oce: adp-class,
adv-class, argo-class,
bremen-class, cm-class,
coastline-class, ctd-class,
lisst-class, lobo-class,
met-class, oce-class,
rsk-class, sealevel-class,
section-class, topo-class,
windrose-class