EnvStats: print.boxcoxCensored – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

print.boxcoxCensored

Print Output of Objective for Box-Cox Power Transformations Based on Type I Censored Data

Description

Formats and prints the results of calling the function boxcoxCensored. This method is automatically called by print when given an object of class "boxcoxCensored".

Usage

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

Arguments

`x`	an object of class `"boxcoxCensored"`. See `boxcoxCensored.object` for details.
`...`	arguments that can be supplied to the `format` function.

Details

This is the "boxcoxCensored" method for the generic function print. Prints the objective name, the name of the data object used, the sample size, the percentage of censored observations, 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.