prop.test: Exact and Approximate Tests for Proportions

Description

The mosaic prop.test provides wrapper functions around the function of the same name in stats. These wrappers provide an extended interface (including formulas). prop.test performs an approximate test of a simple null hypothesis about the probability of success in a Bernoulli or multinomial experiment from summarized data or from raw data.

Usage

prop.test( x, n, p = NULL, alternative = c("two.sided",
    "less", "greater"), conf.level = 0.95, ...)
  ## S3 method for class 'ANY':
prop.test(x, n, p=NULL, alternative =
    c("two.sided", "less", "greater"), conf.level =
    0.95,...)
  ## S3 method for class 'formula':
prop.test( x, n, p=NULL, alternative
    = c("two.sided", "less", "greater"), conf.level = 0.95,
    success=NULL, data.name, data, ...)
  ## S3 method for class 'numeric':
prop.test( x, n, p=NULL, alternative
    = c("two.sided", "less", "greater"), conf.level = 0.95,
    success=NULL, data.name, ...)
  ## S3 method for class 'character':
prop.test( x, n, p=NULL,
    alternative = c("two.sided", "less", "greater"),
    conf.level = 0.95, success=NULL, data.name, ...)
  ## S3 method for class 'logical':
prop.test( x, n, p=NULL, alternative
    = c("two.sided", "less", "greater"), conf.level = 0.95,
    success=NULL, data.name, ...)
  ## S3 method for class 'factor':
prop.test( x, n, p=NULL, alternative =
    c("two.sided", "less", "greater"), conf.level = 0.95,
    success=NULL, data.name, ...)

Arguments

count of successes, length 2 vector of success and failure counts, a formula, or a character, numeric, or factor vector containing raw data.

sample size (successes + failures) or a data frame (for the formula interface)

a vector of probabilities of success. The length of p must be the same as the number of groups specified by x, and its elements must be greater than 0 and less than 1.

alternative

character string specifying the alternative hypothesis, must be one of "two.sided" (default), "greater" or "less". You can specify just the initial letter. Only used for testing the null that a single proport

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.

success

level of variable to be considered success. All other levels are considered failure.

data.name

name for data. If missing, this is inferred from variable names.

data

a data frame (if missing, n may be a data frame)

...

additional arguments (often ignored)

Value

an htest object

Details

This is a wrapper around prop.test to simplify its use when the raw data are available, in which case an extended syntax for prop.test is provided.

Examples

Run this code

# Several ways to get a confidence interval for the proportion of Old Faithful
# eruptions lasting more than 3 minutes.
prop.test( faithful$eruptions > 3 )
prop.test(97,272)
prop.test(c(97,272-97))
faithful$long <- faithful$eruptions > 3
prop.test( faithful$long )
prop.test( ~long , faithful )