events.default: Default variables in events

In eirikmn/bremla: Bayesian Regression Modeling of Layer-Counted Archives

Default variables in events

Description

Sets the default variables in the list events used to specify the climatic periods and separating events used in the linear predictor. The list contains the following arguments:

locations

Numeric describing the location of the transitions between climatic periods. Default value is NULL, and must be provided by user.

locations_unit

Character describing on which axis the locations are given. Can be age, depth or index. Default value is depth.

degree

Integer giving the polynomial degree the individual period-specific covariates should be in. Set to 0 to only include constants between transitions, 1 to also include a linear function between covariates and 2 to include a square function. Default value is 1.

fill_data

Boolean telling whether or not the data object should be filled to include the climate period covariates. Default value is TRUE.

fill_formula

Boolean telling whether or not the formula object should be filled to include description of the period-specific covariates (with degree as given in to events\$degree.). Default value is TRUE.

Usage

events.default()

Value

Returns a list including default values for all variables in events.

Author(s)

Eirik Myrvoll-Nilsen, [e-mail]

See Also

bremla,set.options

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