oce (version 0.1-75)

summary.tide: Summarize a tide object

Description

Summarize a tide object.

Usage

## S3 method for class 'tide':
summary(object, p=0, constituent, \dots)

Arguments

object

a tide object, as created by tidem.

p

the minimum p value for the display of an individual coefficient. The default causes all coefficients to be shown.

constituent

optional name of constituent on which to focus.

...

passed to children.

Value

• An object of class "summary.tide", which is a data frame containing the following.
• Name
  the name of the constituent in non-subscript form, e.g. "M2".
• Frequency
  the frequency of the constituent, in inverse hours.
• Amplitude
  the amplitude of the constituent, in metres (see tidem).
• Phase
  the phase of the constituent (see tidem).
• p
  a sort of p value for the constituent (see tidem).
• sig
  significance codes based on p, with symbols as in summary.lm.

Details

Pertinent summary information is presented.

See Also

tidem fits a tidal model to data (and describes the nature of tide objects), and plot.tide plots a tide object.

Examples

library(oce)
# Halifax data
data(sealevel.hal)
tide <- tidem(sealevel.hal)
summary(tide)