gx.summary1: Display a one-line Summary Statistics Report

In rgr: Applied Geochemistry EDA

Description

Displays a concise one-line summary statistics report, below a heading line, consisting of sample size, number of NAs in the input vector; minimum, maximum and quartiles; robust estimates of the standard deviation (MAD and interquartile based measure); mean, standard deviation and coefficient of variation (%); and the standard error, and lower and upper 95% confidence limits on the mean. See Details for the results of setting log = TRUE. Optionally the data may be logarithmically (base 10) transformed.

Usage

gx.summary1(xx, xname = deparse(substitute(xx)), log = FALSE)

Arguments

xx	name of the variable to be processed.
xname	by default the character string for xx is used for the title. An alternate title can be displayed with xname = "text string", see Examples.
log	if the summary statistics are required following a log10 transformation, set log = TRUE.

Details

Setting log = TRUE results in a log transformation for the parametric statistical estimates. The maximum, minimum, quartiles and robust estimates of spread are estimated and reported in natural measurement units. Of the parametric statistics, the mean (the geometric mean) and 95%confidence are reported backtransformed into natural measurement units. If all the results are required following a log10, or some other transformation, this can be achieved by executing the transformation in the call, e.g., gx.summary1(log10(Cu)) or gx.summary1(sqrt(Cu)), and setting log = FALSE.

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 this function, see ltdl.fix.df.

Any NAs in the data vector will be removed prior to computation in function gx.stats.

For a more extensive summary statistics display, see gx.summary2. For summary graphical displays see shape or inset.

Author(s)

Robert G. Garrett

See Also

gx.summary, gx.stats, ltdl.fix.df, remove.na, gx.summary2

Examples

## Make test data available
data(kola.o)
attach(kola.o)

## Generates an initial display
gx.summary1(Cu)

## Provide a more informative display
gx.summary1(Cu, xname = "Cu (mg/kg) in <2 mm Kola O-horizon soil")

## As above but with a log10 transformation to display
## the geometric mean, etc.
gx.summary1(Cu, xname = "Cu (mg/kg) in <2 mm Kola O-horizon soil", log = TRUE)

## Detach test data
detach(kola.o)

Example output

Loading required package: MASS
Loading required package: fastICA

  Summary Stats for: Cu 

  N  NAs - Min Q1 M Q3 Max - MAD IQR_SD - Mean SD CV% - SE & 95% CLs on Mean

  617 0 - 2.69 6.85 9.69 18.2 4080 - 5.145 8.414 - 43.69 245.5 561.8% - 9.883 24.28 <-> 63.1


  Summary Stats for: Cu (mg/kg) in <2 mm Kola O-horizon soil 

  N  NAs - Min Q1 M Q3 Max - MAD IQR_SD - Mean SD CV% - SE & 95% CLs on Mean

  617 0 - 2.69 6.85 9.69 18.2 4080 - 5.145 8.414 - 43.69 245.5 561.8% - 9.883 24.28 <-> 63.1

  Data log10 transformed: SD, CV% and SE in log10 units, estimates for the
  Mean and 95% CIs have been back-transformed

  Summary Stats for: Cu (mg/kg) in <2 mm Kola O-horizon soil 

  N  NAs - Min Q1 M Q3 Max - MAD IQR_SD - Mean SD CV% - SE & 95% CLs on Mean

  617 0 - 2.69 6.85 9.69 18.2 4080 - 5.145 8.414 - 13.15 0.4323 38.63% - 0.0174 12.15 <-> 14.22

rgr documentation built on May 2, 2019, 6:09 a.m.