Compute Descriptive Summary Statistics of Groups

Share:

Description

Create a table of quantiles and other summary statistics of the data in a cg data object.

Usage

1
descriptiveTable(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 descriptiveTable 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 descriptiveTable components.

...

Additional arguments. Currently only one is valid:

logscale

A logical value, indicating whether or not the geometric means and standard errors should be included in the summary. If logscale is not specified (default), its value is taken from the data object.

Value

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

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

descriptiveTable.cgOneFactorData

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
data(canine)
canine.data <- prepareCGOneFactorData(canine, format="groupcolumns",
                                      analysisname="Canine",
                                      endptname="Prostate Volume",
                                      endptunits=expression(plain(cm)^3),
                                      digits=1, logscale=TRUE, refgrp="CC")
descriptiveTable(canine.data)

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

## Paired Difference Data

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

descriptiveTable(anorexiaFT.data)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.