\HeaderA{breakpoints.ProbBin}{Obtain break points for Probability binning}{breakpoints.ProbBin}
\keyword{dplot}{breakpoints.ProbBin}
\begin{Description}\relax
To define the break points in data.var in which there are
N observations in each bin.
\end{Description}
\begin{Usage}
\begin{verbatim}
breakpoints.ProbBin(data.var, N)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{data.var}] a vector of numeric data values for the break points
to be determined 
\item[\code{N}] the number of data points between two breaks 
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
This function is used to determine the break points that can be used to
specify a \code{\LinkA{ProbBin.FCS}{ProbBin.FCS}} object as well as a \code{\LinkA{hist}{hist}} object.

Please note that each bin in the histograms (in \code{ProbBin.FCS}) will be determined
such that the end point is included (ie, for a<b, (a,b] is the bin
interval for break points a \& b.

Thus, the output of this function will have min(data.var)-1 as the
first break point and max(data.var) as the last break point such
that (min(data.var)-1, min(data.var)] is the first bin/interval
of the break points.
\end{Details}
\begin{Value}
a vector of the numerical breaks
\end{Value}
\begin{Author}\relax
Zoe Moodie, A.J. Rossini, J.Y. Wan
\end{Author}
\begin{References}\relax
Mario Roederer, et al. "Probability Binning Comparison: A
Metric for Quantitating Univariate Distribution Differences" Cytometry
45:37-46 (2001).
\end{References}
\begin{SeeAlso}\relax
\code{\LinkA{ProbBin.FCS}{ProbBin.FCS}}
\code{\LinkA{hist}{hist}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}

  x <- 1:23
  N <- 3

## making a series of cutpoints which have
## an equal number of counts in each bin 
  breaks <- breakpoints.ProbBin(x, N)

  hist(x, br=breaks, plot=FALSE)

\end{ExampleCode}
\end{Examples}

