The R Project SVN R

Rev

Rev 16484 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 16484 Rev 18121
Line 8... Line 8...
8
  \item{x}{a numeric vector for which the boxplot will
8
  \item{x}{a numeric vector for which the boxplot will
9
    be constructed (\code{\link{NA}}s and \code{\link{NaN}}s are allowed
9
    be constructed (\code{\link{NA}}s and \code{\link{NaN}}s are allowed
10
    and omitted).}
10
    and omitted).}
11
  \item{coef}{this determines how far the plot ``whiskers'' extend out
11
  \item{coef}{this determines how far the plot ``whiskers'' extend out
12
    from the box.  If \code{coef} is positive, the whiskers extend to the
12
    from the box.  If \code{coef} is positive, the whiskers extend to the
13
    most extreme data point which is no more than \code{coef} times the
13
    most extreme data point which is no more than \code{coef} times
14
    interquartile coef from the box.  A value of zero causes the whiskers
14
    the length of the box away from the box. A value of zero causes
-
 
15
    the whiskers
15
    to extend to the data extremes (and no outliers be returned).}
16
    to extend to the data extremes (and no outliers be returned).}
16
  \item{do.conf,do.out}{logicals; if \code{FALSE}, the \code{conf} or
17
  \item{do.conf,do.out}{logicals; if \code{FALSE}, the \code{conf} or
17
    \code{out} component respectively will be empty in the result.}
18
    \code{out} component respectively will be empty in the result.}
18
}
19
}
19
\description{
20
\description{
Line 34... Line 35...
34
  Note that \code{$stats} and \code{$conf} are sorted in \emph{in}creasing
35
  Note that \code{$stats} and \code{$conf} are sorted in \emph{in}creasing
35
  order, unlike S, and that \code{$n} and \code{$out} include any
36
  order, unlike S, and that \code{$n} and \code{$out} include any
36
  \code{+- Inf} values.
37
  \code{+- Inf} values.
37
}
38
}
38
\details{
39
\details{
39
  The two ``hinge''s are versions of the first first and third quartile,
40
  The two ``hinges'' are versions of the first first and third quartile,
40
  i.e. close to \code{\link{quantile}(x, c(1,3)/4)}.  The hinges equal
41
  i.e. close to \code{\link{quantile}(x, c(1,3)/4)}.  The hinges equal
41
  the quartiles for odd \eqn{n} (where \code{n <- length(x)}) and
42
  the quartiles for odd \eqn{n} (where \code{n <- length(x)}) and
42
  differ for even \eqn{n}. Where the quartiles only equal observations
43
  differ for even \eqn{n}. Where the quartiles only equal observations
43
  for \code{n \%\% 4 == 1} (\eqn{n\equiv 1 \bmod 4}{n = 1 mod 4}),
44
  for \code{n \%\% 4 == 1} (\eqn{n\equiv 1 \bmod 4}{n = 1 mod 4}),
44
  the hinges do so \emph{additionally} for \code{n \%\% 4 == 2}
45
  the hinges do so \emph{additionally} for \code{n \%\% 4 == 2}