summary.cgOneFactorFit: 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

## S3 method for class '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

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

...

Additional arguments. Only one is currently valid: [object Object] For other possible cgOneFactorFit components such as accelerated failure time or unequal variance model fits, the model argument is not

Value

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

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.

Examples

Run this code

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)