print.cgOneFactorFit {cg}

Print One Factor Model Fit object with some format options

Description

Print a cgOneFactorFit object, which contains fitted model information.

Usage

## S4 method for signature 'cgOneFactorFit'
print(x, title = NULL, endptname = NULL, ...)

Arguments

x

An cgOneFactorFit object.

title

The title printed out with the fitted model information. If NULL, it is set to be "Fitted Models of" the analysisname value in the settings slot of the cgOneFactorFit object.

endptname

The endpoint name, printed out with the fitted model information. If NULL, it is set to the endptname value in the settings slot of the cgOneFactorFit object.

...

Additional arguments. Only one is currently valid:

model

For cgOneFactorFit objects that have output derived from classical least squares lm or resistant & robust rlm fits, the following argument values are possible:

"both"

Both the ordinary classical least squares and resistant & robust model fits are printed. This is the default when both fits are present in the cgOneFactorFit object specified in the x argument.

"olsonly"

Only the ordinary classical least squares model fit is printed.

"rronly"

Only the resistant & robust model fit is printed.

For other possible cgOneFactorFit components such as accelerated failure time or unequal variance model fits, the model argument is not relevant, and the single model fit will just be printed for these model types.

Details

The object is printed using a mix of cat and print calls. See cgOneFactorFit for details of the *fit and other object slots.

This method simply echoes print methods for individual fit classes, such as lm and rlm.

Note that show is an alias for print for this method. A showObj.cgOneFactorFit method is defined to display the raw form of the object.

Value

print.cgOneFactorFit returns invisible. The main purpose is the side effect of printing to the current output connection, which is typically the console.

Note

Contact [e-mail] for bug reports, questions, concerns, and comments.

Author(s)

Bill Pikounis [aut, cre, cph], John Oleynick [aut], Eva Ye [ctb]

See Also

cgOneFactorFit

Examples

data(canine)
canine.data <- prepareCGOneFactorData(canine, format="groupcolumns",
                                      analysisname="Canine",
                                      endptname="Prostate Volume",
                                      endptunits=expression(plain(cm)^3),
                                      digits=1, logscale=TRUE, refgrp="CC")
canine.fit <- fit(canine.data)

print(canine.fit)