summary.impl: Summarize a Data Frame

In burrm/lolcat: Miscellaneous Useful Functions

Summarize a Data Frame

Description

Calculate various summary measures for subgroups defined in a data frame by defining a dependent variable and one or more grouping variables.

Usage

## S3 method for class 'all.variables'
summary(data, summary.default = summary.continuous, ...)

## S3 method for class 'impl'
summary(
  fx,
  data = NULL,
  stat.n = F,
  stat.total.n = F,
  stat.miss = F,
  stat.sum = F,
  stat.mean = F,
  stat.var = F,
  stat.sd = F,
  stat.mean.ADA = F,
  stat.mean.ADM = F,
  stat.mean.ADMn1 = F,
  stat.quantiles = NULL,
  stat.five.number = F,
  stat.min = F,
  stat.q1 = F,
  stat.median = F,
  stat.q3 = F,
  stat.max = F,
  stat.range = F,
  stat.iqr = F,
  stat.psd = F,
  stat.sir = F,
  stat.coefvar = F,
  stat.distinct = F,
  stat.distinct.withna = F,
  stat.true.mode = F,
  stat.shape.rejection.conf.level = NA,
  stat.shape.text.rej = "Reject",
  stat.shape.text.ftr = "",
  stat.ad.test = 0,
  stat.sw.test = 0,
  stat.skew.test = 0,
  stat.kurt.test = 0,
  stat.dago.test = 0,
  stat.pois.dist.test = F,
  stat.sw.exp.test = F,
  stat.sd.report = NULL,
  stat.lsl = NA,
  stat.target = NA,
  stat.usl = NA,
  stat.nonconform.nbelow = F,
  stat.nonconform.nabove = F,
  stat.nonconform.nout = F,
  stat.nonconform.pbelow = F,
  stat.nonconform.pabove = F,
  stat.nonconform.pout = F,
  format.generate.cellcodes = F,
  ...
)

Arguments

data	Data Frame - Data frame to be summarized using names specified in fx
...	Additional Parameters - additional parameters for summary.impl
fx	Formula - variable to be summarized and grouping variables, usually like "dependent.var ~ group1 + group2 + group3 + ...""
stat.n	Logical - return non-NA counts
stat.total.n	Logical - return subgroup counts including NAs
stat.miss	Logical - return NA counts in subgoups
stat.sum	Logical - return subgroup sum
stat.mean	Logical - return subgroup mean
stat.var	Logical - return subgroup sample variance
stat.sd	Logical - return subgroup sample standard deviation
stat.mean.ADA	Logical - return subgroup mean absolute deviation
stat.mean.ADM	Logical - return subgroup median absolute deviation
stat.mean.ADMn1	Logical - return subgroup median absolute deviation with midpoint removed, see also dispersion.ADMn1
stat.quantiles	Vector - return quantiles (input is values between 0 and 1 indicating quantiles, ex .25 for first quartile)
stat.five.number	Logical - return subgroup five number summary (min, Q1, median, Q3, max)
stat.min	Logical - return subgroup minimum
stat.q1	Logical - return subgroup 1st quartile (25th percentile)
stat.median	Logical - return subgroup median (50th percentile)
stat.q3	Logical - return subgroup third quartile (75th percentile)
stat.max	Logical - return subgroup maximum
stat.range	Logical - return subgroup range (max - min)
stat.iqr	Logical - return subgroup interquartile range, abbreviated IQR, defined as (q3 - q1)
stat.psd	Logical - return subgroup pseudo standard deviation (IQR / 1.35)
stat.sir	Logical - return subgroup semi-interquartile range (IQR / 2)
stat.coefvar	Logical - return subgroup coefficient of variation (standard deviation / mean)
stat.distinct	Logical - return subgroup count of distinct values excluding NA
stat.distinct.withna	Logical - return subgroup count of distinct values including NA as a distinct value
stat.true.mode	Logical - return subgroup "true mode", defined as 3*median-2*mean
stat.shape.rejection.conf.level	Numeric - confidence level for rejection for shape tests
stat.shape.text.rej	Character - Text to identify rejected null hypothesis for shape test
stat.shape.text.ftr	Character - Text to identify null hypothesis not rejected for shape test
stat.ad.test	Numeric - Return Anderson Darling test for normality (0=off, 1=if n<25, 2=on)
stat.sw.test	Numeric - Return Shapiro Wilk test for normality (0=off, 1=if n<25, 2=on)
stat.skew.test	Numeric - Return D'Agostino test for skewness (normality) (0=off, 1=if n>=20, 2=on)
stat.kurt.test	Numeric - Return D'Agostino test for kurtosis (normality) (0=off, 1=if n>=20, 2=on)
stat.dago.test	Numeric - Return D'Agostino omnibus test for normality (0=off, 1=if n>=20, 2=on)
stat.pois.dist.test	Logical - Return test for Poisson distribution
stat.sw.exp.test	Logical - Return Shapiro-Wilk exponentiality test
stat.sd.report	Vector - return multiples of subgroup standard deviation
stat.lsl	Numeric - Lower specification limit
stat.target	Numeric - Target value for distribution
stat.usl	Numeric - Upper specification limit
stat.nonconform.nbelow	Logical - Return count of subgroup values below lower specification limit
stat.nonconform.nabove	Logical - Return count of subgroup values above upper specification limit
stat.nonconform.nout	Logical - Return count of subgroup values outside of specification limits
stat.nonconform.pbelow	Logical - Return percentage of subgroup values below lower specification limit
stat.nonconform.pabove	Logical - Return percentage of subgroup values above upper specification limit
stat.nonconform.pout	Logical - Return percentage of subgroup values outside of specification limits
format.generate.cellcodes	Logical - Calculate/return group cell codes

Value

A data frame with subgroups and selected measures

burrm/lolcat documentation built on Sept. 15, 2023, 11:35 a.m.