| tidedata {oce} | R Documentation |
The tidedata dataset contains Tide-constituent
information that is use by tidem to fit tidal models.
tidedata is a list containing
constname (a string with constituent name),
freq (the frequency, in cycles per hour),
kmpr (a string naming the comparison constituent, blank if there is
none),
ikmpr (index of comparison constituent, or 0 if there is none),
df (frequency difference betwee constituent and its comparison,
used in the Rayleigh criterion),
d1 (first Doodson number),
d2,
d3,
d4,
d5,
d6 (sixth Doodson number),
semi,
nsat (number of satellite constituents),
ishallow,
nshallow,
doodsonamp,
and doodsonspecies.satdeldood,
phcorr,
amprat,
ilatfac,
and iconst.shallowiconst,
coef,
and iname.
Apart from the use of d1 through d6, the naming and
content follows T_TIDE. All of this is based on Foreman
(1977), to which the reader is referred for details.
To get a list of all the available tidal constituents, do
cat("all constituents:",tidedata$const$name)
and to get a list of the so-called standard coefficients, do
cat("standard constituents:",tidedata$const$name[tidedata$const$ikmpr])
data(tidedata)
Dan Kelley
The data come from the tide3.dat file of the
T_TIDE package (Pawlowicz et al., 2002), and derive from
Appendices provided by Foreman (1977). The data are scanned using
‘tests/tide.R’ in this package, which also performs some tests using
T_TIDE values as a reference.
Foreman, M. G. G., 1977. Manual for tidal heights analysis and prediction. Pacific Marine Science Report 77-10, Institute of Ocean Sciences, Patricia Bay, Sidney, BC, 58pp.
Pawlowicz, Rich, Bob Beardsley, and Steve Lentz, 2002.
Classical tidal harmonic analysis including error estimates in MATLAB using T_TIDE.
Computers and Geosciences, 28, 929-937.
tidem is used to fit tidal models using tidedata.