Skip to content

Commit

Permalink
Update docstring for binomial confidence intervals
Browse files Browse the repository at this point in the history
The existing docstring described the available confidence interval
methods for power divergence test, not for the binomial test.

The new docstring now describes the binomial CI methods that are used.
  • Loading branch information
juliangehring authored and nalimilan committed Aug 22, 2017
1 parent cf392fc commit 48558c8
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/binomial.jl
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,13 @@ pvalue(x::BinomialTest; tail=:both) = pvalue(Binomial(x.n, x.p), x.x; tail=tail)
```julia
function confint(x::HypothesisTest, alpha::Float64=0.05; tail=:both, method=:clopper_pearson)
```
Compute a confidence interval with coverage 1-alpha for multinomial proportions using one of the following methods. Possible values for method are:
Compute a confidence interval with coverage 1-alpha for binomial proportions using one of the following methods. Possible values for method are:
Sison, Glaz intervals :sison_glaz (default):
Bootstrap intervals :bootstrap :
Quesenberry, Hurst intervals :quesenberry_hurst :
Gold intervals :gold (Asymptotic simultaneous intervals):
- Clopper-Pearson :clopper_pearson (default)
- Agresti-Coull :agresti_coull
- Jeffrey :jeffrey
- Wald :wald
- Wilson :wilson
"""
function StatsBase.confint(x::BinomialTest, alpha::Float64=0.05; tail=:both, method=:clopper_pearson)
check_alpha(alpha)
Expand Down

0 comments on commit 48558c8

Please sign in to comment.