R: Print a Paired Difference Descriptive Table object with some...

print.cgPairedDifferenceDescriptiveTable {cg}

R Documentation

Print a Paired Difference Descriptive Table object with some format options

Description

Print a cgPairedDifferenceDescriptiveTable object, which contains a table of quantiles and other summary statistics of the data from a cgPairedDifferenceData object.

Usage

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

Arguments

`x`	A `cgPairedDifferenceDescriptiveTable` object, typically created by `descriptiveTable.cgPairedDifferenceData`.
`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 `cgPairedDifferenceDescriptiveTable` object.
`title`	The title printed out with the table. If `NULL`, it is set to be "Descriptive Table of" the `analysisname` value taken from the `settings` slot of the `cgPairedDifferenceDescriptiveTable` object.
`endptname`	The endpoint name of the data summarized in the table. If NULL, it is set to the `endptname` value taken from the `settings` slot of the `cgPairedDifferenceDescriptiveTable` object.
`...`	Additional arguments. None are currently defined for this method.

Details

The object is printed using a mix of cat and print calls. See cgPairedDifferenceDescriptiveTable for details of the contents and other object slots.

Value

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

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
descriptiveTable(anorexiaFT.data)

print(descriptiveTable(anorexiaFT.data, display="none"))

## A change in title
print(descriptiveTable(anorexiaFT.data, display="none"),
      title="Quantiles and Summary Statistics")

[Package cg version 1.0-3 Index]