mosaic (version 0.9-0)

mean: Aggregating functions

Description

The mosaic package makes several summary statistic functions (like mean and sd) formula aware.

Usage

mean(x, ..., data, groups = NULL, ..fun.. = base::mean,
  na.rm = getOption("na.rm", FALSE))
median(x, ..., data, groups = NULL, ..fun.. = stats::median,
  na.rm = getOption("na.rm", FALSE))
range(x, ..., data, groups = NULL, ..fun.. = base::range,
  na.rm = getOption("na.rm", FALSE))
sd(x, ..., data, groups = NULL, ..fun.. = stats::sd,
  na.rm = getOption("na.rm", FALSE))
max(x, ..., data, groups = NULL, ..fun.. = base::max,
  na.rm = getOption("na.rm", FALSE))
min(x, ..., data, groups = NULL, ..fun.. = base::min,
  na.rm = getOption("na.rm", FALSE))
sum(x, ..., data, groups = NULL, ..fun.. = base::sum,
  na.rm = getOption("na.rm", FALSE))
IQR(x, ..., data, groups = NULL, ..fun.. = stats::IQR,
  na.rm = getOption("na.rm", FALSE))
fivenum(x, ..., data, groups = NULL, ..fun.. = stats::fivenum,
  na.rm = getOption("na.rm", FALSE))
iqr(x, ..., data, groups = NULL, ..fun.. = stats::IQR,
  na.rm = getOption("na.rm", FALSE))
prod(x, ..., data, groups = NULL, ..fun.. = base::prod,
  na.rm = getOption("na.rm", FALSE))
sum(x, ..., data, groups = NULL, ..fun.. = base::sum,
  na.rm = getOption("na.rm", FALSE))
favstats(x, ..., data, groups = NULL, ..fun.. = fav_stats, na.rm = TRUE)
var(x, ..., data, groups = NULL, ..fun.. = stats::var,
  na.rm = getOption("na.rm", FALSE))
cor(x, y = NULL, ..., data = parent.frame())
cov(x, y = NULL, ..., data = parent.frame())

Arguments

x

an object, often a formula

y

an object, often a numeric vector

..fun..

the underlyin function used in the computation

groups

a grouping variable, typically a name of a variable in data

data

a data frame in which to evaluate formulas (or bare names)

...

additional arguments

na.rm

a logical indicating whether NAs should be removed before computing

Examples

mean( HELPrct$age )
mean( ~ age, data=HELPrct )
mean( age ~ sex + substance, data=HELPrct )
mean( ~ age | sex + substance, data=HELPrct )
mean( sqrt(age), data=HELPrct )
sum( ~ age, data=HELPrct )
sd( HELPrct$age )
sd( ~ age, data=HELPrct )
sd( age ~ sex + substance, data=HELPrct )
var( HELPrct$age )
var( ~ age, data=HELPrct )
var( age ~ sex + substance, data=HELPrct )
IQR( width ~ sex, data=KidsFeet )
iqr( width ~ sex, data=KidsFeet )
favstats( width ~ sex, data=KidsFeet )

cor( length ~ width, data=KidsFeet )
cov ( length ~ width, data=KidsFeet )