EnvStats (version 2.3.1)

print.boxcoxLm: Print Output of Objective for Box-Cox Power Transformations for an "lm" Object

Description

Formats and prints the results of calling the function boxcox when the argument x supplied to boxcox is an object of class "lm". This method is automatically called by print when given an object of class "boxcoxLm". The names of other functions involved in Box-Cox transformations are listed under Data Transformations.

Usage

# S3 method for boxcoxLm
print(x, ...)

Arguments

x

an object of class "boxcoxLm". See boxcoxLm.object for details.

arguments that can be supplied to the format function.

Value

Invisibly returns the input x.

Details

This is the "boxcoxLm" method for the generic function print. Prints the objective name, the details of the "lm" object used, the sample size, the values of the powers, and the values of the objective. In the case of optimization, also prints the range of powers over which the optimization took place.

References

Chambers, J. M. and Hastie, T. J. (1992). Statistical Models in S. Wadsworth & Brooks/Cole.

See Also

boxcox, boxcoxLm.object, plot.boxcoxLm, Data Transformations, print.