control.linramp.default: Default variables in control.linramp

View source: R/default_arguments.R

control.linramp.defaultR Documentation

Default variables in control.linramp

Description

Sets the default variables in the list control.linramp used to specify the linear ramp model fitting procedure for a given transition. The list contains the following arguments:

  • label Character used to describe the name of the transition in future plot. Default NULL.

  • proxy Numeric giving the proxy data to perform the linear ramp model fit. Default value is NULL meaning that it must be provided by the user.

  • interval Interval describing the window of proxy to perform the linear ramp model fit. Default value is NULL so it must be given by the user.

  • interval.unit Character giving which axis is used for interval. Can be "depth" (default), "age" or "index".

  • depth.label Character describing what label to place on x-axis (depth) in a future plot. Default value is "".

  • depth.ref Numeric giving a reference value for the depth which will be included in a future plot.

  • opt.params Numeric describing initial values for optim function used to find good initial values for the inla fitting procedure. If this is set to NULL (default) the code will provide its own initial values.

  • compute.t1 Boolean indicating whether or not transition end point t1 should be computed. Default TRUE.

  • nsims Integer giving how many Monte Carlo samples should be used to compute transition end point t1 if compute.t1 is TRUE.

  • rescale.y.factor If proxies (y-axis) should be rescaled, this can be done using this command. y_new = y_old*rescale.y.factor.

  • imp.fit Boolean indicating whether initial values for inla be computed using optim.

  • log.theta.prior Function argument which returns the logarithmic value of the joint prior of the rescaled hyperparameters theta used in the linear ramp model. If NULL (default) then default priors will be assumed (see code in rgeneric.r file).

  • h Step length of optimization procedure in the inla-program. Default value is 0.01.

  • ncores Integer giving the number of cores used in the inla-program. For rgeneric models which are used here, stability can sometimes be improved if the number of cores is set to 1, which is why it is the default here.

  • silent If equal to TRUE or 1L, then inla will run in "silent" mode, If equal to 2L then error messages will also be suppressed.

  • verbose Boolean stating whether or not the inla-program should run in verbose mode. Default FALSE.

Usage

control.linramp.default()

Value

Returns a list including default values for all variables in control.linramp.

Author(s)

Eirik Myrvoll-Nilsen, eirikmn91@gmail.com

See Also

bremla, linrampfitter, events_depth_to_age,set.options


eirikmn/bremla documentation built on Jan. 25, 2025, 4:41 a.m.