This class stores Ruskin data, from RBR (see reference 1).
Details
A rsk object may be read with read.rsk() or created with
as.rsk(), but the former method is much preferred because it
retains the entirety of the information in the file.
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, rskPatm() may provide guidance as to its value,
but this is no equal to record-keeping at sea.
Slots
dataAs with all
oceobjects, thedataslot forrskobjects is a list containing the main data for the object.metadataAs with all
oceobjects, themetadataslot forrskobjects is a list containing information about thedataor about the object itself.processingLogAs with all
oceobjects, theprocessingLogslot forrskobjects is a list with entries describing the creation and evolution of the object. The contents are updated by variousocefunctions to keep a record of processing steps. Object summaries andprocessingLogShow()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 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 rsk
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 [[,rsk-method
operator, as e.g. o[["data"]] and o[["metadata"]], respectively.
The [[,rsk-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.
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,
xbt-class
Other things related to rsk data:
[[,rsk-method,
[[<-,rsk-method,
as.rsk(),
ctdFindProfilesRBR(),
plot,rsk-method,
read.rsk(),
rsk,
rskPatm(),
rskToc(),
subset,rsk-method,
summary,rsk-method