R: Predict a Time Series from a Tidal Model

predict.tidem {oce} | R Documentation

## Predict a Time Series from a Tidal Model

### Description

Predict a time series from a tidal model.

### Usage

    ## S3 method for class 'tidem'
    predict(object, newdata, ...)

### Arguments

`object` | A `tidem` object, i.e. one inheriting from `tidem-class`.
`newdata` | vector of POSIXt times at which to make the prediction. For models created with `tidem`, `newdata` is optional, and if it is not provided, then the predictions are at the observation times given to `tidem`. However, `newdata` is required, if `as.tidem` had been used to create `object`.
`...` | optional arguments passed on to children.

### Value

A vector of predictions.

### Author(s)

Dan Kelley

### See Also

Other things related to tides: `[[,tidem-method`, `[[<-,tidem-method`, `as.tidem`, `plot,tidem-method`, `summary,tidem-method`, `tidedata`, `tidem-class`, `tidemAstron`, `tidemVuf`, `tidem`, `webtide`

### Examples

    ## Not run:
    library(oce)
    # 1. tidal anomaly
    data(sealevelTuktoyaktuk)
    time <- sealevelTuktoyaktuk[["time"]]
    elevation <- sealevelTuktoyaktuk[["elevation"]]
    oce.plot.ts(time, elevation, type='l', ylab="Height [m]", ylim=c(-2, 6))
    tide <- tidem(sealevelTuktoyaktuk)
    lines(time, elevation - predict(tide), col="red")
    abline(h=0, col="red")

    # 2. prediction at specified times
    data(sealevel)
    m <- tidem(sealevel)
    ## Check fit over 2 days (interpolating to finer timescale)
    look <- 1:48
    time <- sealevel[["time"]]
    elevation <- sealevel[["elevation"]]
    oce.plot.ts(time[look], elevation[look])
    # 360s = 10 minute timescale
    t <- seq(from=time[1], to=time[max(look)], by=360)
    lines(t, predict(m, newdata=t), col='red')
    legend("topright", col=c("black","red"),
    legend=c("data","model"),lwd=1)

    ## End(Not run)

[Package oce version 1.1-1 Index]