transffit: Transformation of the data.

In spaMM: Mixed-Effect Models, with or without Spatial Random Effects

Transformation of the data.

Description

transffit is an experimental helper function to fit a transformation of the data, such as the Box-Cox transformation which is the implemented default. It is not particularly optimized, but is intended to help users to do it right. When a non-default transformation is used, it is important to provide the corresponding logDetJac argument.

Usage

transffit(object, lower= -2, upper=2, verbose = FALSE, 
  extracts = quote({
    y <- object$y
  }), 
  updates = quote({
    if (lambda == 0) {
        newy <- log(y)
    } else newy <- (y^lambda - 1)/lambda
    refit <- update_resp(object, newresp = newy)
  }), 
  logDetJac = quote({
    (lambda - 1) * sum(log(y))
  }))

Arguments

object	A fit object to the untransformed data, as produced by fitme or fitmv.
lower, upper	Numeric vectors: optimization bounds (the function tentatively allows multiparameter transformations).
verbose	Boolean: whether to print inforamtion about the progress of the procedure.
extracts	A quoted R expression providing variables that should be available in the environment of the objective function, which refits the model on transformed variables. The default expression extracts the response variable so that it can be transformed by the objective function.
updates	A quoted R expression providing the transformation (whose mandatory parameter names is lambda) applied to the response variable (and optionally to other variables), and computes the refitted model (with mandatory named refit).
logDetJac	The logarithm of the determinant of the Jacobian of the transformation of the response variable, which is required to recover the likelihood, as the probability density of the original data, given the likelihod of the fit to the transformed data (Box and Cox 1964, eq.5).

Value

A list with elements the result of the optimization call, and the fit of the model to the best transformed data.

References

Box, G. E. P. and Cox, D. R. (1964) An analysis of transformations (with discussion). Journal of the Royal Statistical Society B, 26, 211–252.

Examples

set.seed(123)
data(wafers)
wafers$x <- (rnorm(198, mean=(wafers$y)^(1/2),sd=0.1))^2
toyfit <- fitme(y ~x+(1|batch),data=wafers)

# Default transformation (Cox-Box)
transffit(toyfit, lower=-2,upper=2)

## Not run: 
# power transformation of response
transffit(toyfit, 
       updates = quote({   
         newy <- y^lambda
         refit <- update_resp(object, newresp = newy)
       }),
       logDetJac = quote({sum((lambda-1)*log(y)+log(lambda))}),
       lower=0.1, upper=2)

# Less standard power transformation of response *and* of predictor
# The update(object, data=.) syntax will be used
# so the 'data' must be extracted and updated:
transffit(toyfit,
       extracts = quote({
         locdata <- object$data
         y <- locdata$y
         x <- locdata$x
       }),
       updates = quote({   
         locdata$x <- x^lambda
         locdata$y <- y^lambda
         refit <- update(object, data=locdata)
       }),
       logDetJac = quote({sum((lambda-1)*log(y)+log(lambda))}),
       lower=0.1, upper=2)

## End(Not run)

spaMM documentation built on Sept. 10, 2026, 1:07 a.m.