The R Project SVN – R – Diff – /trunk/src/library/base/man/boxplot.stats.Rd



\arguments{
\item{x}{a numeric vector for which the boxplot will
be constructed (\code{NA}s are allowed).}
\item{coef}{this determines how far the plot ``whiskers''
extend out from the box.
If \code{coef} is positive,
the whiskers extend to the most extreme data point which
is no more than \code{coef} times the interquartile coef
from the box.
A value of zero causes the whiskers to extend to the data extremes.}
}
\value{
This function is typically is called by \code{boxplot} to
gather the statistics necessary for producing box plots,
but may be invoked separately.  The value it returns is
a list with named components as follows:
\item{stats}{a vector containing the extreme of the
lower whisker, the lower ``hinge'', the median, the upper ``hinge''
and the extreme of the upper whisker.}
\item{n}{the number of observations in the sample.}
\item{conf}{the lower and upper extremes of the ``notch''.}

\examples{
boxplot.stats(1:100)
boxplot.stats(1:100, coef = 3)
boxplot.stats(1:100, coef = 0)
}
\keyword{dplot}

The R Project SVN R

(root)/trunk/src/library/base/man/boxplot.stats.Rd @ 862 – Rev 2 → 286

Rev 2		Rev 286
Line 7...		Line 7...
7	`\arguments{`	7	`\arguments{`
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{NA}s are allowed).}`	9	`be constructed (\code{NA}s are allowed).}`
10	\item{coef}{this determines how far the plot ``whiskers''	10	\item{coef}{this determines how far the plot ``whiskers''
11	`extend out from the box.`	11	`extend out from the box.`
12	`If \code{coef} is positive,`	12	`If \code{coef} is positive,`
13	`the whiskers extend to the most extreme data point which`	13	`the whiskers extend to the most extreme data point which`
14	`is no more than \code{coef} times the interquartile coef`	14	`is no more than \code{coef} times the interquartile coef`
15	`from the box.`	15	`from the box.`
16	`A value of zero causes the whiskers to extend to the data extremes.}`	16	`A value of zero causes the whiskers to extend to the data extremes.}`
17	`}`	17	`}`
18	`\value{`	18	`\value{`
19	`This function is typically is called by \code{boxplot} to`	19	`This function is typically is called by \code{boxplot} to`
20	`gather the statistics necessary for producing box plots,`	20	`gather the statistics necessary for producing box plots,`
21	`but may be invoked separately. The value it returns is`	21	`but may be invoked separately. The value it returns is`
22	`a list with named components as follows:`	22	`a list with named components as follows:`
23	`\item{stats}{a vector containing the extreme of the`	23	`\item{stats}{a vector containing the extreme of the`
24	lower whisker, the lower ``hinge'', the median, the upper ``hinge''	24	lower whisker, the lower ``hinge'', the median, the upper ``hinge''
25	`and the extreme of the upper whisker.}`	25	`and the extreme of the upper whisker.}`
26	`\item{n}{the number of observations in the sample.}`	26	`\item{n}{the number of observations in the sample.}`
27	\item{conf}{the lower and upper extremes of the ``notch''.}	27	\item{conf}{the lower and upper extremes of the ``notch''.}
Line 34...		Line 34...
34	`\examples{`	34	`\examples{`
35	`boxplot.stats(1:100)`	35	`boxplot.stats(1:100)`
36	`boxplot.stats(1:100, coef = 3)`	36	`boxplot.stats(1:100, coef = 3)`
37	`boxplot.stats(1:100, coef = 0)`	37	`boxplot.stats(1:100, coef = 0)`
38	`}`	38	`}`
-		39	`\keyword{dplot}`