print.cgPairedDifferenceComparisonsTable {cg}

Print Paired Difference Comparisons Table object with some format options

Description

Print a cgPairedDifferenceComparisonsTable object, which contains a table of comparisons based on the cgPairedDifferenceFit object.

Usage

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

Arguments

x

An cgPairedDifferenceComparisonsTable object, typically created by
comparisonsTable.cgPairedDifferenceFit.

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
cgPairedDifferenceComparisonsTable object.

title

The title printed out with the table. If NULL, it is set to be "Comparisons Table of" the analysisname value taken from the settings slot of the
cgPairedDifferenceComparisonsTable 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 cgPairedDifferenceComparisonsTable object.

...

Additional arguments. Only one is currently valid:

model

For cgPairedDifferenceComparisonsTable 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 cgPairedDifferenceComparisonsTable object specified in the x argument.

"olsonly"

Only the ordinary classical least squares group comparisons table is printed.

"rronly"

Only the resistant & robust comparisons table is printed.

Details

The smallest actual p-value that will be printed is 0.001. Anything less than 0.001 will be displayed as < 0.001. If you need more digits, see the cgPairedDifferenceComparisonsTable object.

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

Value

print.cgPairedDifferenceComparisonsTable 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]

Examples

data(anorexiaFT)

anorexiaFT.data <- prepareCGPairedDifferenceData(anorexiaFT, format="groupcolumns",
                                                 analysisname="Anorexia FT",
                                                 endptname="Weight",
                                                 endptunits="lbs",
                                                 expunitname="Patient",
                                                 digits=1,
                                                 logscale=TRUE)

anorexiaFT.fit <- fit(anorexiaFT.data)

anorexiaFT.comps <- comparisonsTable(anorexiaFT.fit)

print(anorexiaFT.comps, digits=2)

print(anorexiaFT.comps, model="olsonly")