R: Class to Store Tidal Models

tidem-class {oce} | R Documentation

## Class to Store Tidal Models

### Description

This class stores tidal-constituent models.

### Slots

`data`

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

`metadata`

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

`processingLog`

  As with all `oce` objects, the `processingLog` slot for `tidem` 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 tidem objects (see `[[<-,tidem-method`), it is better to use `oceSetData()` and `oceSetMetadata()`, because those functions save an entry in the `processingLog` that describes the change.

### Retrieving slot contents

The full contents of the `data` and `metadata` slots of a tidem object may be retrieved in the standard R way using `slot()`. For example `slot(o,"data")` returns the `data` slot of an object named `o`, and similarly `slot(o,"metadata")` returns the `metadata` slot.

The slots may also be obtained with the `[[,tidem-method` operator, as e.g. `o[["data"]]` and `o[["metadata"]]`, respectively.

The `[[,tidem-method` operator can also be used to retrieve items from within the `data` and `metadata` slots. For example, `o[["temperature"]]` can be used to retrieve temperature from an object containing that quantity. The rule is that a named quantity is sought first within the object's `metadata` slot, with the `data` slot being checked only if `metadata` does not contain the item. This `[[` method can also be used to get certain derived quantities, if the object contains sufficient information to calculate them. For example, an object that holds (practical) salinity, temperature and pressure, along with longitude and latitude, has sufficient information to compute Absolute Salinity, and so `o[["SA"]]` will yield the calculated Absolute Salinity.

It is also possible to find items more directly, using `oceGetData()` and `oceGetMetadata()`, but neither of these functions can retrieve derived items.

### Author(s)

Dan Kelley

### See Also

Other functions that plot oce data: `download.amsr()`, `plot,adp-method`, `plot,adv-method`, `plot,amsr-method`, `plot,argo-method`, `plot,bremen-method`, `plot,cm-method`, `plot,coastline-method`, `plot,ctd-method`, `plot,gps-method`, `plot,ladp-method`, `plot,landsat-method`, `plot,lisst-method`, `plot,lobo-method`, `plot,met-method`, `plot,odf-method`, `plot,rsk-method`, `plot,satellite-method`, `plot,sealevel-method`, `plot,section-method`, `plot,tidem-method`, `plot,topo-method`, `plot,windrose-method`, `plot,xbt-method`, `plotProfile()`, `plotScan()`, `plotTS()`

Other things related to tides: `[[,tidem-method`, `[[<-,tidem-method`, `as.tidem()`, `plot,tidem-method`, `predict.tidem()`, `summary,tidem-method`, `tidalCurrent`, `tidedata`, `tidemAstron()`, `tidemVuf()`, `tidem`, `webtide()`

[Package oce version 1.7-2 Index]