summary.cgOneFactorFit {cg}

Summary display of a One Factor Model Fit object with some format options

Description

Summary printing of a cgOneFactorFit object, which contains fitted model information.

Usage

## S4 method for signature 'cgOneFactorFit'
summary(object, title = NULL, endptname = NULL, ...)

Arguments

object

An cgOneFactorFit object.

title

The title printed out with the summary of the fitted model(s). If NULL, it is set to be "Fitted Model Summaries 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 fit summaries are printed. This is the default when both fits are present in the cgOneFactorFit object specified in the object argument.

"olsonly"

Only the ordinary classical least squares model fit summary is printed.

"rronly"

Only the resistant & robust model fit summary 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 summary is printed for these model types.

Details

The object summary 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 summary methods for individual fit classes, such as lm and rlm.

Value

summary.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)

summary(canine.fit)