tidem-class: Class to Store Tidal Models

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

Description

This class stores tidal-constituent models.

Slots

data

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

metadata

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

processingLog

As with all oce objects, the processingLog slot for tidem 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 tidem objects (see [[<-,tidem-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 tidem object named tidem may be retrieved in the standard R way. For example, slot(tidem, "data") and slot(tidem, "metadata") return the data and metadata slots, respectively. The [[,tidem-method operator can also be used to access slots, with tidem[["data"]] and tidem[["metadata"]], respectively. Furthermore, [[,tidem-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 functions that plot oce data: plot,adp-method, plot,adv-method, plot,amsr-method, plot,argo-method, plot,bremen-method, plot,cm-method, plot,coastline-method, plot,ctd-method, plot,gps-method, plot,ladp-method, plot,landsat-method, plot,lisst-method, plot,lobo-method, plot,met-method, plot,odf-method, plot,rsk-method, plot,satellite-method, plot,sealevel-method, plot,section-method, plot,tidem-method, plot,topo-method, plot,windrose-method, plotProfile, plotScan, plotTS

Other things related to tidem data: [[,tidem-method, [[<-,tidem-method, plot,tidem-method, predict.tidem, summary,tidem-method, tidedata, tidemAstron, tidemVuf, tidem


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