modulus: Modulus transformation for linear models

In trafo: Estimation, Comparison and Selection of Transformations

Description

The function transforms the dependent variable of a linear model using the Modulus transformation. The transformation parameter can either be estimated using different estimation methods or given.

Usage

modulus(object, lambda = "estim", method = "ml", lambdarange = c(-2,
  2), plotit = TRUE)

Arguments

object	an object of type lm.
lambda	either a character named "estim" if the optimal transformation parameter should be estimated or a numeric value determining a given value for the transformation parameter. Defaults to "estim".
method	a character string. Different estimation methods can be used for the estimation of the optimal transformation parameter: (i) Maximum likelihood approach ("ml"), (ii) Skewness minimization ("skew"), (iii) Kurtosis optimization ("kurt"), (iv) Divergence minimization by Kolmogorov-Smirnov ("div.ks"), by Cramer-von-Mises ("div.cvm") or by Kullback-Leibler ("div.kl"). Defaults to "ml".
lambdarange	a numeric vector with two elements defining an interval that is used for the estimation of the optimal transformation parameter. Defaults to c(-2, 2).
plotit	logical. If TRUE, a plot that illustrates the optimal transformation parameter or the given transformation parameter is returned. Defaults to TRUE.

Value

An object of class trafo. Methods such as as.data.frame.trafo and print.trafo can be used for this class.

References

John JA, Draper NR (1980). An alternative family of transformations. Journal of the Royal Statistical Society: Series C, 29, 190-197.

Examples

# Load data
data("cars", package = "datasets")

# Fit linear model
lm_cars <- lm(dist ~ speed, data = cars)

# Transform dependent variable with fixed lambda 
modulus(object = lm_cars, lambda = 0.8, plotit = FALSE)

Example output

Registered S3 method overwritten by 'pryr':
  method      from
  print.bytes Rcpp
Modulus Transformation 

Estimation method:  ml  
Optimal parameter:  0.8  
Loglike:  131.1553 

Summary of transformed variables 
   Min. 1st Qu.  Median    Mean 3rd Qu.    Max. 
   1.76   16.21   21.21   23.84   30.49   56.71 

trafo documentation built on May 2, 2019, 2:13 p.m.