options-class {arf3DS4} | R Documentation

## arf3DS4 "options" class

### Description

The arf3DS4 "options" class contains the options of the minimization procedure (including starting value calculation, and (co)variance estimation). Mostly used by ARF "model" objects (see `model`).

### Objects

Objects can be created by calls of the form `new("options", ...)`.

### Slots

`nlm.gradtol`:

  <nlm> Gradient tolerance (not used).

`nlm.steptol`:

  <nlm> Step tolerance (not used).

`opt.method`:

  <optim> Optim method (L-BFGS-B).

`opt.lower`:

  <optim> Lowerbound of parameters (for L-BFGS-B).

`opt.upper`:

  <optim> Upperbound of parameters (for L-BFGS-B).

`min.analyticalgrad`:

  Use analytical gradient in minimization?

`min.iterlim`:

  Iteration limit.

`min.boundlim`:

  Persistent Boundary iteration limit.

`min.routine`:

  Minimization routine (optim).

`start.method`:

  Method of startingvalue calculation (`'use'`,`'load'`,or `'rect'`)

`start.maxfac`:

  Width of smoothing kernel used in starting value calculation.

`start.vector`:

  Starting value template (used for default values).

`chk.method`:

  Check method for parameters of minimized solution.

`chk.range`:

  Range of values to check parameters of minimized solution.

`sw.type`:

  Use diagonal residual matrix or full residual matrix in sandwich (co)variance calculation.

`output.mode`:

  Vector with output types (`'none'` or `'progress'`).

`version`:

  Object of class "version" (see `version`)

### Methods

Standard arf3DS4 accessor and replacement functions can be used to access and replace slots.

access

  `.classname.slotname(object)`

replace

  `.classname.slotname(object)<-`

In this case classname is "options" and slotname is for example "sw.type". So to access the "sw.type" slot of an r-object "myoptions" (of class "options") type `.options.sw.type(myoptions)`.

### Author(s)

Wouter D. Weeda - w.d.weeda@gmail.com

### See Also

`model`

### Examples

    showClass("options")

[Package arf3DS4 version 2.5-10 Index]