winsrch_optim: Find the optimal half-window width combination

View source: R/winsrch_optim.R

winsrch_optimR Documentation

Find the optimal half-window width combination

Description

Find the optimal half-window width combination to use for weighted regression.

Usage

winsrch_optim(dat_in, ...)

## Default S3 method:
winsrch_optim(
  dat_in,
  wins_in = NULL,
  control = list(factr = 1e+07, parscale = c(1, 10, 1)),
  lower = c(0.1, 1, 0.1),
  upper = c(2, 15, 2),
  ...
)

Arguments

dat_in

input data object to use with weighted regression

...

arguments passed to wrtdscv, wrtds, or getwts

wins_in

starting list of window weights for initializing the search algorithm

control

A list of control parameters passed to optim (see details in optim help file). The value passed to factr controls the convergence behavior of the "L-BFGS-B" method. Values larger than the default will generally speed up the optimization with a potential loss of precision. parscale describes the scaling values of the parameters.

lower

vector of minimum half-window widths to evaluate

upper

vector of maximum half-window widths to evaluate

Details

This function uses optim to minimize the error returned by wrtdscv for a given window combination. The search algorithm uses the limited-memory modification of the BFGS quasi-Newton method to impose upper and lower limits on the optimization search. These limits can be changed using the lower and upper arguments.

Value

Some stuff

See Also

wrtdscv, winsrch_grid

Examples

## Not run: 
# setup parallel backend
library(doParallel)
ncores <- detectCores() - 1  
registerDoParallel(cores = ncores)

# run search function - takes a while
res <- winsrch_optim(tidobjmean)

## End(Not run)

WRTDStidal documentation built on Oct. 20, 2023, 5:08 p.m.