arguments.link {BTSR}R Documentation

Shared documentation for link functions

Description

This is the common documentation for arguments related link functions in BTSR models.

Arguments

error.scale

either 0 or 1; the scale for the error term. Default is error.scale = 1 (predictive scale).

linkg

link functions. Can be specified as a character, two-character vector or a named list. The corresponding text strings for currently available links are listed in link.btsr. Default values depend on the model. For some models default values override user specifications. See the Section Link defaults for details.

linkh

a character indicating which link must be associated to the chaotic process. See the Section ‘The BTSR structure’ in btsr-package for details and link.btsr for valid links. Default is linkh = "linear".

configs.linkg

a list with two elements, ctt and power, which define the constant a and the exponent b in the link function g(x) = a x^b. Each element can be specified as a numeric value, a vector of size 2 or a named list. The default is configs.linkg = NULL. See the Section Link defaults for details.

configs.linkh

a list with extra configurations for the link h. For now, only used if linkh = "linear" or "polynomial". Default is configs.linkh = list(ctt = 1, power = 1).

Link defaults

linkh and configs.linkh only apply to BARC models.

linkg can be specified in one of two ways

For models that do not have the \nu parameter, the links g2, g21, g22 and g23 are set to "linear" for compatibility with Fortran subroutines.

Missing entries in the linkg list follow these rules

Default linkg values are model-dependent (based on the string provided with model):

configs.linkg if provided, it must be provided as a list with optional elements, ctt and power, which define the constant a and the exponent b in the link function g(x) = a x^b. Each element in this list can be specified in one of two ways

For now, the arguments ctt and power are only used when the link function is "linear" or "polynomial". If NULL, default is to assume that ctt and power are both equal to 1 for all links.

See Also

BTSR.model.defaults: function to print default settings for a specified model


[Package BTSR version 1.0.0 Index]