R: Class to Store Bremen-formatted Data

bremen-class {oce} | R Documentation

## Class to Store Bremen-formatted Data

### Description

This class is for data stored in a format used at Bremen. It is somewhat similar to the `odf-class`, in the sense that it does not apply just to a particular instrument. Although some functions are provided for dealing with these data (see “Details”), the most common action is to read the data with `read.bremen`, and then to coerce the object to another storage class (e.g. using `as.ctd` for CTD-style data) so that specialized functions can be used thereafter.

### Slots

`data`

  As with all `oce` objects, the `data` slot for `bremen` objects is a `list` containing the main data for the object.

`metadata`

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

`processingLog`

  As with all `oce` objects, the `processingLog` slot for `bremen` 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 `bremen` objects (see `[[<-,bremen-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 `bremen` object named `bremen` may be retrieved in the standard R way. For example, `slot(bremen, "data")` and `slot(bremen, "metadata")` return the `data` and `metadata` slots, respectively. The `[[,bremen-method` operator can also be used to access slots, with `bremen[["data"]]` and `bremen[["metadata"]]`, respectively. Furthermore, `[[,bremen-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 classes provided by `oce`: `adp-class`, `adv-class`, `argo-class`, `cm-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`

Other things related to `bremen` data: `[[,bremen-method`, `[[<-,bremen-method`, `plot,bremen-method`, `read.bremen`, `summary,bremen-method`

[Package oce version 1.0-1 Index]