R: Class to Store Sealevel Data

sealevel-class {oce} | R Documentation

## Class to Store Sealevel Data

### Description

This class stores sealevel data, e.g. from a tide gauge.

### Slots

`data`

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

`metadata`

  As with all `oce` objects, the `metadata` slot for `sealevel` objects is a `list` containing information about the `data` or about the object itself. An example of the former might be the location at which a `sealevel` measurement was made, stored in `longitude` and `latitude`, and of the latter might be `filename`, the name of the data source.

`processingLog`

  As with all `oce` objects, the `processingLog` slot for `sealevel` 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 `sealevel` objects (see `[[<-,sealevel-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 `sealevel` object named `sealevel` may be retrieved in the standard R way. For example, `slot(sealevel, "data")` and `slot(sealevel, "metadata")` return the `data` and `metadata` slots, respectively. The `[[,sealevel-method` operator can also be used to access slots, with `sealevel[["data"]]` and `sealevel[["metadata"]]`, respectively. Furthermore, `[[,sealevel-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`, `bremen-class`, `cm-class`, `coastline-class`, `ctd-class`, `lisst-class`, `lobo-class`, `met-class`, `oce-class`, `odf-class`, `rsk-class`, `section-class`, `topo-class`, `windrose-class`

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

[Package oce version 1.1-1 Index]