alfareg.tune: Tuning the value of alpha in the alpha-regression

View source: R/alfareg.tune.R

Tuning the value of alpha in the alpha-regressionR Documentation

Tuning the value of \alpha in the \alpha-regression

Description

Tuning the value of \alpha in the \alpha-regression.

Usage

alfareg.tune(y, x, a = seq(0.1, 1, by = 0.1), nfolds = 10,
folds = NULL, nc = 1, seed = NULL, graph = FALSE)

Arguments

y

A matrix with compositional data. zero values are allowed.

x

A matrix with the continuous predictor variables or a data frame including categorical predictor variables.

a

The value of the power transformation, it has to be between -1 and 1. If zero values are present it has to be greater than 0. If \alpha=0 the isometric log-ratio transformation is applied.

nfolds

The number of folds to split the data.

folds

If you have the list with the folds supply it here. You can also leave it NULL and it will create folds.

nc

The number of cores to use. IF you have a multicore computer it is advisable to use more than 1. It makes the procedure faster. It is advisable to use it if you have many observations and or many variables, otherwise it will slow down th process.

seed

You can specify your own seed number here or leave it NULL.

graph

If graph is TRUE a plot of the performance for each fold along the values of \alpha will appear.

Details

The \alpha-transformation is applied to the compositional data and the numerical optimisation is performed for the regression, unless \alpha=0, where the coefficients are available in closed form.

Value

A plot of the estimated Kullback-Leibler divergences (multiplied by 2) along the values of \alpha (if graph is set to TRUE). A list including:

runtime

The runtime required by the cross-validation.

kula

A matrix with twice the Kullback-Leibler divergence of the observed from the fitted values. Each row corresponds to a fold and each column to a value of \alpha. The average over the columns equal the next argument, "kl".

kl

A vector with twice the Kullback-Leibler divergence of the observed from the fitted values. Every value corresponds to a value of \alpha.

opt

The optimal value of \alpha.

value

The minimum value of twice the Kullback-Leibler.

Author(s)

Michail Tsagris.

R implementation and documentation: Michail Tsagris mtsagris@uoc.gr and Giorgos Athineou <gioathineou@gmail.com>.

References

Tsagris M. (2015). Regression analysis with compositional data containing zero values. Chilean Journal of Statistics, 6(2): 47-57. https://arxiv.org/pdf/1508.01913v1.pdf

Tsagris M.T., Preston S. and Wood A.T.A. (2011). A data-based power transformation for compositional data. In Proceedings of the 4th Compositional Data Analysis Workshop, Girona, Spain. https://arxiv.org/pdf/1106.1451.pdf

See Also

alfa.reg, alfa

Examples

library(MASS)
y <- as.matrix(fgl[1:40, 2:4])
y <- y /rowSums(y)
x <- as.vector(fgl[1:40, 1])
mod <- alfareg.tune(y, x, a = seq(0, 1, by = 0.1), nfolds = 5)

Compositional documentation built on Oct. 23, 2023, 5:09 p.m.