oce (version 0.2-1)

summary.tidem: Summarize a tide-model object

Description

summary method for class "tidem".

Usage

## S3 method for class 'tidem':
summary(object, p, constituent, \dots)
## S3 method for class 'summary.tidem':
print(x, digits=max(6, getOption("digits")-1),
      signif.stars= getOption("show.signif.stars"), ...)

Arguments

object

an object of class "tidem", usually, a result of a call to tidem.

x

an object of class "tidem", usually, a result of a call to summary.tidem.

digits

the number of significant digits to use when printing.

p

optional value of the maximum p value for the display of an individual coefficient. If not given, all coefficients are shown.

constituent

optional name of constituent on which to focus.

signif.stars

logical. If TRUE, significance stars are printed for each value.

...

further arguments passed to or from other methods.

Value

• An object of class "summary.tidem", which contains pertinent information about the fitted tidal model and its misfit to the data.

Details

By default, all fitted constituents are plotted, but it is quite useful to set e.g. p=0.05 To see just those constituents that are significant at the 5 percent level.

Note that the p values are estimated as the average of the p values for the sine and cosine components at a given frequency.

See Also

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

Examples

library(oce)
# Halifax data
data(sealevelHalifax)
tide <- tidem(sealevelHalifax)
summary(tide)