print.boxcox: Print Output of Objective for Box-Cox Power Transformations

print.boxcoxR Documentation

Print Output of Objective for Box-Cox Power Transformations

Description

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

Usage

## S3 method for class 'boxcox'
print(x, ...)

Arguments

x

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

...

arguments that can be supplied to the format function.

Details

This is the "boxcox" method for the generic function print. Prints the objective name, the name of the data 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.

Value

Invisibly returns the input x.

Author(s)

Steven P. Millard (EnvStats@ProbStatInfo.com)

References

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

See Also

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


EnvStats documentation built on Aug. 22, 2023, 5:09 p.m.