cg (version 1.0-3)

correlationTable: Compute Correlations

Description

Create a table of correlations of the data in a cg data object.

Usage

correlationTable(data, display = "print", ...)

Arguments

data

A data object created and prepared (see prepare) using the cg package.

display

One of three valid values:

"print"

The default value; It calls a print method for the created correlationTable object, which is a formatted text output of the table.

"none"

Supresses any printing. Useful, for example, when just assignment of the resulting object is desired.

"show"

Calls the default showDefault method, which will just print out the correlationTable components.

...

Additional arguments. Currently only one is valid:

logscale

A logical value, indicating whether the correlation of the log transformed data should be calculated. If logscale is not specified (default), its value is taken from the data object's component in the settings slot.

Value

A method-specific correlationTable object is returned. See the specific methods for discussion of return values.

See Also

correlationTable.cgPairedDifferenceData

Examples

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