oce (version 1.1-1)

argo-class: Class to Store Argo Data

Description

This class stores data from Argo floats.

Arguments

Slots

data

As with all oce objects, the data slot for argo objects is a list containing the main data for the object. The key items stored in this slot include equal-length vectors time, longitude, latitude and equal-dimension matrices pressure, salinity, and temperature.

metadata

As with all oce objects, the metadata slot for argo objects is a list containing information about the data or about the object itself. Examples that are of common interest include id, a vector of ID codes for the profiles, and dataMode, a vector of strings indicating whether the profile is in archived mode ("A"), realtime mode ("R"), or delayed mode ("D").

processingLog

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

Details

An argo object may be read with read.argo or created with as.argo. Argo data can be gridded to constant pressures with argoGrid or subsetted with subset,argo-method. Plots can be made with plot,argo-method, while summary,argo-method produces statistical summaries and show produces overviews.

See http://www.argo.ucsd.edu/Gridded_fields.html for some argo-related datasets that may be useful in a wider context.

See Also

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

Other things related to argo data: [[,argo-method, [[<-,argo-method, argoGrid, argoNames2oceNames, argo, as.argo, handleFlags,argo-method, plot,argo-method, read.argo, subset,argo-method, summary,argo-method