| Line 25... |
Line 25... |
| 25 |
\arguments{
|
25 |
\arguments{
|
| 26 |
\item{x}{a vector of values for which the histogram is desired.}
|
26 |
\item{x}{a vector of values for which the histogram is desired.}
|
| 27 |
\item{breaks}{one of:
|
27 |
\item{breaks}{one of:
|
| 28 |
\itemize{
|
28 |
\itemize{
|
| 29 |
\item a vector giving the breakpoints between histogram cells,
|
29 |
\item a vector giving the breakpoints between histogram cells,
|
| - |
|
30 |
\item a function to compute the vector of breakpoints,
|
| 30 |
\item a single number giving the number of cells for the histogram,
|
31 |
\item a single number giving the number of cells for the histogram,
|
| 31 |
\item a character string naming an algorithm to compute the
|
32 |
\item a character string naming an algorithm to compute the
|
| 32 |
number of cells (see \sQuote{Details}),
|
33 |
number of cells (see \sQuote{Details}),
|
| 33 |
\item a function to compute the number of cells.
|
34 |
\item a function to compute the number of cells.
|
| 34 |
}
|
35 |
}
|
| 35 |
In the last three cases the number is a suggestion only.
|
36 |
In the last three cases the number is a suggestion only. If
|
| - |
|
37 |
\code{breaks} is a function, the \code{x} vector is supplied to it
|
| - |
|
38 |
as the only argument.
|
| 36 |
}
|
39 |
}
|
| 37 |
\item{freq}{logical; if \code{TRUE}, the histogram graphic is a
|
40 |
\item{freq}{logical; if \code{TRUE}, the histogram graphic is a
|
| 38 |
representation of frequencies, the \code{counts} component of
|
41 |
representation of frequencies, the \code{counts} component of
|
| 39 |
the result; if \code{FALSE}, probability densities, component
|
42 |
the result; if \code{FALSE}, probability densities, component
|
| 40 |
\code{density}, are plotted (so that the histogram has a total area
|
43 |
\code{density}, are plotted (so that the histogram has a total area
|
| Line 117... |
Line 120... |
| 117 |
are supplied are \code{"Scott"} and \code{"FD"} /
|
120 |
are supplied are \code{"Scott"} and \code{"FD"} /
|
| 118 |
\code{"Freedman-Diaconis"} (with corresponding functions
|
121 |
\code{"Freedman-Diaconis"} (with corresponding functions
|
| 119 |
\code{\link{nclass.scott}} and \code{\link{nclass.FD}}).
|
122 |
\code{\link{nclass.scott}} and \code{\link{nclass.FD}}).
|
| 120 |
Case is ignored and partial matching is used.
|
123 |
Case is ignored and partial matching is used.
|
| 121 |
Alternatively, a function can be supplied which
|
124 |
Alternatively, a function can be supplied which
|
| 122 |
will compute the intended number of breaks as a function of \code{x}.
|
125 |
will compute the intended number of breaks or the actual breakpoints
|
| - |
|
126 |
as a function of \code{x}.
|
| 123 |
}
|
127 |
}
|
| 124 |
\value{
|
128 |
\value{
|
| 125 |
an object of class \code{"histogram"} which is a list with components:
|
129 |
an object of class \code{"histogram"} which is a list with components:
|
| 126 |
\item{breaks}{the \eqn{n+1} cell boundaries (= \code{breaks} if that
|
130 |
\item{breaks}{the \eqn{n+1} cell boundaries (= \code{breaks} if that
|
| 127 |
was a vector). These are the nominal breaks, not with the boundary fuzz.}
|
131 |
was a vector). These are the nominal breaks, not with the boundary fuzz.}
|