Print One Factor Group Summary Table object with some format options

Share:

Description

Print a cgOneFactorGrpSummaryTable object, which contains a table of group means and variability based on the cgOneFactorFit object.

Usage

1
2
## S4 method for signature 'cgOneFactorGrpSummaryTable'
print(x, digits = NULL, title = NULL, endptname = NULL, ...)

Arguments

x

An cgOneFactorGrpSummaryTable object, typically created by
grpSummaryTable.cgOneFactorFit.

digits

The number of decimal places to use in the output. If NULL, then the number of decimal places is taken from the digits value in the settings slot of the cgOneFactorGrpSummaryTable object.

title

The title printed out with the table. If NULL, it is set to be "Group Summary Table of" the analysisname value from the settings slot of the cgOneFactorGrpSummaryTable object.

endptname

The endpoint name, printed out with the table. If NULL, it is set to the endptname value from the settings slot of the cgOneFactorGrpSummaryTable object.

...

Additional arguments. Only one is currently valid:

model

For cgOneFactorGrpSummaryTable objects that have tables 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 comparisons tables are printed. This is the default when both fits are present in the cgOneFactorGrpSummaryTable object specified in the x argument.

"olsonly"

Only the ordinary classical least squares comparisons table is printed.

"rronly"

Only the resistant and robust comparisons table is printed.

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

Details

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

Value

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

Note

Contact cg@billpikounis.net for bug reports, questions, concerns, and comments.

Author(s)

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

See Also

cgOneFactorGrpSummaryTable

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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)

canine.grpsumm <- grpSummaryTable(canine.fit)

print(canine.grpsumm, digits=2)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.