gamlss2

Control Parameters

Description

Control parameters for fitting GAMLSS models with gamlss2.

Usage

gamlss2_control(optimizer = RS, trace = TRUE,
  flush = TRUE, light = FALSE, expand = TRUE,
  model = TRUE, x = TRUE, y = TRUE,
  fixed = FALSE, ...)

Arguments

optimizer Function, the optimizer to be used for fitting. Use JR for joint REML estimation.

trace Logical, should information be printed while the algorithm is running?

flush Logical, whether to use flush.console to display current output in the console.

light Logical, if set to light = TRUE, no model frame, response, model matrix and other design matrices will be part of the return value.

expand Logical, if fewer formulas are supplied than there are parameters of the distribution, should intercept-only formulas be added automatically?

model Logical, should the model frame be included as a component of the returned object.

x Logical, indicating whether the model matrix should be included as a component of the returned object.

y Logical, should the response be included as a component of the returned object.

fixed Named logical vector indicating which parameters should be fixed during estimation. See gamlss2_start for examples.

… Further control parameters to be included in the return value, for example parameters used by the optimizer function RS.

Details

The set of control parameters can be extended. For example, if a different optimizer is used, newly specified control parameters are passed on to that optimizer automatically.

Optimizer-specific controls and algorithm details are documented in RS and CG, and in JR for joint REML estimation. Smoothing parameter selection is described in gamlss2_smoothing.

Value

A list with the arguments specified.

Examples

library("gamlss2")

f <- dist ~ s(speed) | s(speed)

## specify fitting controls
ctrl <- gamlss2_control(trace = FALSE, maxit = c(50, 100))
m <- gamlss2(f, data = cars, family = GA, control = ctrl)