rsk-class: Class to Store Rsk Data

Description Details Slots Modifying slot contents Retrieving slot contents Author(s) References See Also

Description

This class stores “Ruskin” data, from RBR [1].

Details

A rsk object may be read with read.rsk or created with as.rsk. Plots can be made with plot,rsk-method, while summary,rsk-method produces statistical summaries and show produces overviews. If atmospheric pressure has not been removed from the data, the functions rskPatm may provide guidance as to its value; however, this last function is no equal to decent record-keeping at sea.

Slots

data

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

metadata

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

processingLog

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

References

1. RBR website: www.rbr-global.com/products

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, sealevel-class, section-class, topo-class, windrose-class

Other things related to rsk data: [[,rsk-method, [[<-,rsk-method, as.rsk, plot,rsk-method, read.rsk, rskPatm, rskToc, rsk, subset,rsk-method, summary,rsk-method


oce documentation built on Oct. 4, 2018, 5:04 p.m.