rgr: gx.summary – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

gx.summary

Compiles a Table of Summary Statistics

Description

This function is a ‘sub-engine’ between the main summary statistics engine, ‘gx.stats’, and the gx.summary.* display functions, it does not generate any output to the current device. Its ‘sub-engine’ function is to select the required results from the gx.stats computations, and additionally compute 95% confidence bounds on means.

Usage

gx.summary(xx, log = log, iftell = iftell)

Arguments

`xx`	name of the variable to be processed.
`log`	set `log = TRUE` if it is required to compute statistics following a log10 transformation of the data.
`iftell`	passes the value of `iftell` for controlling the display of the `NA` count to function `remove.na` from the calling function.

Value

`table`	a 15-element vector containing summary statistics, see below:
`[1]`	the sample size, N.
`[2]`	the number of NAs removed from the data passed for processing.
`[3:7]`	the minimum value, Q1, Median, Q3 and maximum value.
`[8]`	the Median Absolute Deviation (MAD).
`[9]`	the Inter-Quartile Standard Deviation (IQSD).

The contents of elements [10:15] depend on the ‘value’ of log

`[10]`	the data (sample) Mean.
`[11]`	the data (sample) Standard Deviation (SD).
`[12]`	the Coefficient of Variation as a percentage (CV%).
`[13]`	the Standard Error (S.E.) of the Mean.
`[14]`	the Lower 95% Confidence Limit on the Mean.
`[15]`	the Upper 95% Confidence Limit on the Mean.

If log = TRUE, the results for the mean, [13], and confidence limits, [14:15], are backtransformed to the natural scale.

The returned table is rounded to 4 significant figures.

Note

Any less than detection limit values represented by negative values, or zeros or other numeric codes representing blanks in the data, must be removed prior to executing gx.summary.* functions that call this function, see ltdl.fix.df.

Any NAs in the data vector will be removed prior to computation in function gx.stats. Depending on the value of iftell, the NA count will be displayed, iftell = TRUE, or suppressed, iftell = FALSE.

There are no examples for this function. To display the summary statistics use one of the summary statistics display functions: gx.stats, gx.summary1; gx.summary2; gx.summary.mat;
gx.summary.groups; framework.stats; or framework.summary.

Author(s)

Robert G. Garrett