R: Class to Store LOBO Data

lobo-class {oce} | R Documentation

## Class to Store LOBO Data

### Description

This class stores LOBO data.

### Details

A `lobo` object may be read with `read.lobo` or constructed with `as.lobo`. Plots can be made with `plot,lobo-method`, while `summary,lobo-method` produces statistical summaries. Data within a `lobo` object may be retrieved with `[[,lobo-method` and altered with `[[,lobo-method`.

### Slots

`data`

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

`metadata`

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

`processingLog`

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

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

[Package oce version 1.0-1 Index]