print.cgOneFactorDescriptiveTable {cg} | R Documentation |
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
## S4 method for signature 'cgOneFactorDescriptiveTable'
print(x, digits = NULL, title = NULL, endptname = NULL, ...)
Arguments
x |
A |
digits |
The number of decimal places to use in the output. If |
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
cgOneFactorDescriptiveTable
for details of the contents
and other object slots.
Value
print.cgOneFactorDescriptiveTable
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
Examples
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"))