hmean {comparator} | R Documentation |
Harmonic Mean
Description
Harmonic Mean
Usage
hmean(x, ...)
## Default S3 method:
hmean(x, trim = 0, na.rm = FALSE, ...)
Arguments
x |
An R object. Currently there are methods for numeric/logical
vectors and date, date-time and time interval objects. Complex vectors
are allowed for |
... |
further arguments passed to or from other methods. |
trim |
the fraction (0 to 0.5) of observations to be trimmed from each
end of |
na.rm |
a logical value indicating whether |
Value
If trim
is zero (the default), the harmonic mean of the values
in x
is computed, as a numeric or complex vector of length one. If x
is not logical (coerced to numeric), numeric (including integer) or
complex, NA_real_
is returned, with a warning.
If trim
is non-zero, a symmetrically trimmed mean is computed with a
fraction of trim observations deleted from each end before the mean
is computed.
See Also
mean
for the arithmetic mean and gmean
for the geometric
mean.
Examples
x <- c(1:10, 50)
xm <- hmean(x)