R: Class to Store Current Meter Data

cm-class {oce} | R Documentation

## Class to Store Current Meter Data

### Description

This class stores current meter data, e.g. from an Interocean/S4 device or an Aanderaa/RCM device. A file containing Interocean/S4 data may be read with `read.cm`. Alternatively, `as.cm` can be used to create `cm` objects. Objects of this class can be plotted with `plot,cm-method` or summarized with `summary,cm-method`.

### Slots

`data`

  As with all `oce` objects, the `data` slot for `cm` objects is a `list` containing the main data for the object. The key items stored in this slot are `time`, `u` and `v`.

`metadata`

  As with all `oce` objects, the `metadata` slot for `cm` objects is a `list` containing information about the `data` or about the object itself.

`processingLog`

  As with all `oce` objects, the `processingLog` slot for `cm` 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.

### Modifying slot contents

Although the `[[<-` operator may permit modification of the contents of `cm` objects (see `[[<-,cm-method`), it is better to use `oceSetData` and `oceSetMetadata`, because that will save an entry in the `processingLog` to describe the change.

### Retrieving slot contents

The full contents of the `data` and `metadata` slots of a `cm` object named `cm` may be retrieved in the standard R way. For example, `slot(cm, "data")` and `slot(cm, "metadata")` return the `data` and `metadata` slots, respectively. The `[[,cm-method` operator can also be used to access slots, with `cm[["data"]]` and `cm[["metadata"]]`, respectively. Furthermore, `[[,cm-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.

### Author(s)

Dan Kelley

### See Also

Other things related to cm data: `[[,cm-method`, `[[<-,cm-method`, `as.cm`, `cm`, `plot,cm-method`, `read.cm`, `rotateAboutZ`, `subset,cm-method`, `summary,cm-method`

Other classes provided by oce: `adp-class`, `adv-class`, `argo-class`, `bremen-class`, `coastline-class`, `ctd-class`, `lisst-class`, `lobo-class`, `met-class`, `oce-class`, `odf-class`, `rsk-class`, `sealevel-class`, `section-class`, `topo-class`, `windrose-class`

[Package oce version 1.1-1 Index]