Skip to content

Commit e40a36d

Browse files
author
maechler
committed
make it even more clear to *which* median high and low apply
git-svn-id: https://svn.r-project.org/R/trunk@88376 00db46b3-68df-0310-9c12-caf00c1e9a41
1 parent 7ac8e68 commit e40a36d

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/library/stats/man/mad.Rd

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,20 @@ mad(x, center = median(x), constant = 1.4826, na.rm = FALSE,
1212
\alias{mad}
1313
\arguments{
1414
\item{x}{a numeric vector.}
15-
\item{center}{Optionally, the centre: defaults to the median.}
15+
\item{center}{optionally, a number, the centre: defaults to the median.}
1616
\item{constant}{scale factor.}
1717
\item{na.rm}{if \code{TRUE} then \code{NA} values are stripped
1818
from \code{x} before computation takes place.}
19-
\item{low}{if \code{TRUE}, compute the \sQuote{lo-median}, i.e., for even
20-
sample size, do not average the two middle values, but take the
21-
smaller one.}
22-
\item{high}{if \code{TRUE}, compute the \sQuote{hi-median}, i.e., take the
19+
\item{low}{if \code{TRUE}, compute the \sQuote{lo-median} of the absolute
20+
deviations, i.e., for even sample size, do not average the two middle
21+
values, but take the smaller one.}
22+
23+
\item{high}{if \code{TRUE}, compute the \sQuote{hi-median} of \eqn{|x - <center>|}, i.e., take the
2324
larger of the two middle values for even sample size.}
2425
}
2526
\description{
2627
Compute the median absolute deviation, i.e., the (lo-/hi-) median of
27-
the absolute deviations from the median, and (by default) adjust by a
28+
the absolute deviations from the median (or another \code{center}), and (by default) adjust by a
2829
factor for asymptotically normal consistency.
2930
}
3031
\details{

0 commit comments

Comments
 (0)