\Header{prop.test}{Test for Equal or Given Proportions}
\keyword{htest}{prop.test}
\begin{Description}\relax
\code{prop.test} can be used for testing the null that the
proportions (probabilities of success) in several groups are the
same, or that they equal certain given values.
\end{Description}
\begin{Usage}
\begin{verbatim}
prop.test(x, n, p = NULL,
          alternative = c("two.sided", "less", "greater"),
          conf.level = 0.95, correct = TRUE)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{x}] a vector of counts of successes or a matrix with 2 columns
giving the counts of successes and failures, respectively.
\item[\code{n}] a vector of counts of trials; ignored if \code{x} is a
matrix.
\item[\code{p}] a vector of probabilities of success.  The length of
\code{p} must be the same as the number of groups specified by
\code{x}, and its elements must be greater than 0 and less than 1.
\item[\code{alternative}] a character string specifying the alternative
hypothesis, must be one of \code{"two.sided"} (default),
\code{"greater"} or \code{"less"}.  You can specify just the initial
letter.  Only used for testing the null that a single proportion
equals a given value, or that two proportions are equal; ignored
otherwise.
\item[\code{conf.level}] confidence level of the returned confidence
interval.  Must be a single number between 0 and 1.  Only used
when testing the null that a single proportion equals a given
value, or that two proportions are equal; ignored otherwise.
\item[\code{correct}] a logical indicating whether Yates' continuity
correction should be applied.
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
Only groups with finite numbers of successes and failures are used.
Counts of successes and failures must be nonnegative and hence not
greater than the corresponding numbers of trials which must be
positive.  All finite counts should be integers.

If \code{p} is \code{NULL} and there is more than one group, the null
tested is that the proportions in each group are the same.  If there
are two groups, the alternatives are that the probability of success
in the first group is less than, not equal to, or greater than the
probability of success in the second group, as specified by
\code{alternative}.  A confidence interval for the difference of
proportions with confidence level as specified by \code{conf.level}
and clipped to \eqn{[-1,1]}{} is returned.  Continuity correction is
used only if it does not exceed the difference of the sample
proportions in absolute value.  Otherwise, if there are more than 2
groups, the alternative is always \code{"two.sided"}, the returned
confidence interval is \code{NULL}, and continuity correction is never
used.

If there is only one group, then the null tested is that the
underlying probability of success is \code{p}, or .5 if \code{p} is
not given.  The alternative is that the probability of success if less
than, not equal to, or greater than \code{p} or 0.5, respectively, as
specified by \code{alternative}.  A confidence interval for the
underlying proportion with confidence level as specified by
\code{conf.level} and clipped to \eqn{[0,1]}{} is returned.  Continuity
correction is used only if it does not exceed the difference between
sample and null proportions in absolute value. The confidence interval 
is computed by inverting the score test.

Finally, if \code{p} is given and there are more than 2 groups, the
null tested is that the underlying probabilities of success are those
given by \code{p}.  The alternative is always \code{"two.sided"}, the
returned confidence interval is \code{NULL}, and continuity correction
is never used.
\end{Details}
\begin{Value}
A list with class \code{"htest"} containing the following
components:
\begin{ldescription}
\item[\code{statistic}] the value of Pearson's chi-squared test statistic.
\item[\code{parameter}] the degrees of freedom of the approximate
chi-squared distribution of the test statistic.
\item[\code{p.value}] the p-value of the test.
\item[\code{estimate}] a vector with the sample proportions \code{x/n}.
\item[\code{conf.int}] a confidence interval for the true proportion if
there is one group, or for the difference in proportions if
there are 2 groups and \code{p} is not given, or \code{NULL}
otherwise.  In the cases where it is not \code{NULL}, the
returned confidence interval has an asymptotic confidence level
as specified by \code{conf.level}, and is appropriate to the
specified alternative hypothesis.
\item[\code{null.value}] the value of \code{p} if specified by the null, or
\code{NULL} otherwise.
\item[\code{alternative}] a character string describing the alternative.
\item[\code{method}] a character string indicating the method used, and
whether Yates' continuity correction was applied.
\item[\code{data.name}] a character string giving the names of the data.
\end{ldescription}
\end{Value}
\begin{SeeAlso}\relax
\code{\Link{binom.test}} for an \emph{exact} test of a binomial
hypothesis.
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
heads <- rbinom(1, size=100, pr = .5)
prop.test(heads, 100)          # continuity correction TRUE by default
prop.test(heads, 100, correct = FALSE)

## Data from Fleiss (1981), p. 139.
## H0: The null hypothesis is that the four populations from which
##     the patients were drawn have the same true proportion of smokers.
## A:  The alternative is that this proportion is different in at
##     least one of the populations.

smokers  <- c( 83, 90, 129, 70 )
patients <- c( 86, 93, 136, 82 )
prop.test(smokers, patients)
\end{ExampleCode}
\end{Examples}

