R: Class to Store Lowered-adp Data

ladp-class {oce} | R Documentation

## Class to Store Lowered-adp Data

### Description

This class stores data measured with a lowered ADP (also known as ADCP) device.

### Slots

`data`

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

`metadata`

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

`processingLog`

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

[Package oce version 1.0-1 Index]