print.cgPairedDifferenceCorrelationTable {cg} | R Documentation |
Print a Paired Difference Correlation Table object with some format options
Description
Print a cgPairedDifferenceCorrelationTable
object, which contains a table of
correlations of the data from a
cgPairedDifferenceData
object.
Usage
## S4 method for signature 'cgPairedDifferenceCorrelationTable'
print(x, title = NULL, endptname = NULL, ...)
Arguments
x |
A |
title |
The title printed out with the table. If |
endptname |
The endpoint name of the data summarized in the table. If NULL, it is set to
the |
... |
Additional arguments. None are currently defined for this method. |
Details
The object is printed using a mix of cat
and print
calls. See
cgPairedDifferenceCorrelationTable
for details of the contents
and other object slots.
Two decimal places are used in the display of the correlations.
Value
print.cgPairedDifferenceCorrelationTable
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
cgPairedDifferenceCorrelationTable
Examples
data(anorexiaFT)
anorexiaFT.data <- prepareCGPairedDifferenceData(anorexiaFT, format="groupcolumns",
analysisname="Anorexia FT",
endptname="Weight",
endptunits="lbs",
expunitname="Patient",
digits=1,
logscale=TRUE)
## Next two calls are equivalent
correlationTable(anorexiaFT.data)
print(correlationTable(anorexiaFT.data, display="none"))
## A change in title
print(correlationTable(anorexiaFT.data, display="none"),
title="Correlations")