resscls: Get the scale parameters for predicted values

Description Usage Arguments Details Value Examples

View source: R/resscls.R

Description

Get the scale parameters for predicted values of the response variable, only applies to tidalmean objects.

Usage

1
2
3
4
resscls(dat_in, ...)

## S3 method for class 'tidalmean'
resscls(dat_in, dat_pred = NULL, ...)

Arguments

dat_in

input tidalmean object

...

arguments passed to or from other methods

dat_pred

optional data to predict using the interpolation grids in dat_in, defaults to observed data in dat_in if not supplied

Details

This function is used after wrtds to get scale parameters for predicted values of the response variable from the interpolation grids. The values are based on a bilinear interpolation of the four predicted response values at two salinity/flow and two date values nearest to the observed salinity/flow and date values to predict.

Value

Appends columns to the data.frame for the associated scale value for the predicted values. A column is appended to the dat_in object, named ‘scls’.

Examples

1
2
3
4
5
6
7
##

# load a tidalmean object
data(tidobjmean)

# get predicted values
res <- resscls(tidobjmean)

fawda123/WRTDStidal documentation built on Sept. 20, 2020, 1:41 p.m.