means {NMcalc}

calculate arithmetic or geometric mean and confidence intervals

Description

calculate arithmetic or geometric mean and confidence intervals

Usage

means(
  x,
  type = "arithmetic",
  na.rm = FALSE,
  z.rm = FALSE,
  ci = FALSE,
  dist.ci = "t",
  p.ci = 0.95,
  colnames = c("est", "ll", "ul"),
  format = "df"
)

Arguments

x

vector to calculate the geometric mean of

type

type of mean or median. Default is arithmetic, geometric and median are available as well. Only first letters needed, so say "geo" or even "g" is enough.

na.rm

Remove NA's before doing calculations?

z.rm

removes zeros before calculation? Default is FALSE. Can only be TRUE if type="geometric".

ci

if TRUE, a data.frame including point estimate and confidence interval returned. If FALSE, a numeric representing the mean value returned.

dist.ci

The distribution to use for the confidence interval. Default and only supported is "t". If type=geometric, this is applied after transformation to gaussian.

p.ci

probability covered by confidence interval. Default is 0.95

colnames

If ci, this defines the column names of the resulting data frame. Default is c("est","ll","ul").

format

The format of the result. Possible values are df and num.

Value

If ci=FALSE, a numeric. If ci=TRUE, a data.frame.

Examples

x <- 1:100
means(x, type="arithmetic", ci=TRUE)
means(x, type="geometric", ci=TRUE)
means(x, type="median", ci=TRUE)
library(data.table)
## CRAN requires examples to run on a single thread
data.table::setDTthreads(1)
data.table(x=x)[,append(means(x,ci=TRUE),list(N=.N))]