R: Class to Store LISST Data

lisst-class {oce} | R Documentation

## Class to Store LISST Data

### Description

This class stores LISST (Laser in-situ scattering and transmissometry) data.

### Details

One may read `lisst` objects with `read.lisst`, generate them with `as.lisst`, plot them with `plot,lisst-method`, and summarize them with `summary,lisst-method`. Elements may be extracted with `[[,lisst-method` or replaced with `[[<-,lisst-method`.

### Slots

`data`

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

`metadata`

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

`processingLog`

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

### References

A users's manual for the LISST-100 instrument is available at the manufacturer's website http://www.sequoiasci.com.

### See Also

Other classes provided by oce: `adp-class`, `adv-class`, `argo-class`, `bremen-class`, `cm-class`, `coastline-class`, `ctd-class`, `lobo-class`, `met-class`, `oce-class`, `odf-class`, `rsk-class`, `sealevel-class`, `section-class`, `topo-class`, `windrose-class`

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

[Package oce version 1.1-1 Index]