print.cgOneFactorDescriptiveTable: Print a One Factor Descriptive Table object with some format options

Description

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

Usage

"print"(x, digits = NULL, title = NULL, endptname = NULL, ...)

Arguments

A cgOneFactorDescriptiveTable object, typically created by descriptiveTable.cgOneFactorData.

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

...

Additional arguments. None are currently defined for this method.

Value

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

Details

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

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")

## Next two calls are equivalent
descriptiveTable(canine.data)

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

print(descriptiveTable(canine.data, display="none"),
      title="Quantiles and Summary Statistics")

## Censored Data
data(gmcsfcens)
gmcsfcens.data <- prepareCGOneFactorData(gmcsfcens, format="groupcolumns",
                                         analysisname="cytokine",
                                         endptname="GM-CSF (pg/ml)",
                                         logscale=TRUE)

## Next two calls are equivalent
descriptiveTable(gmcsfcens.data, display="print")
print(descriptiveTable(gmcsfcens.data, display="none"))