R/bscCI.R

In rbscCI: Blyth-Still-Casella Confidence Interval

#' Blyth-Still-Casella confidence interval
#' 
#' @details Computes the exact Blyth-Still-Casella binomial confidence interval. The initial CI is the Clopper-Pearson confidence interval.
#'
#' @param n_tot Total number of experiments
#' @param n_suc Number of successes
#' @param conf Confidence level (1-alpha)
#' @param digits Number of decimal places to be used
#'
#' @return A vector containing the confidence interval. If \code{digits} is given, both upper and lower limits are rounded to the given number of digits.
#' 
#' @examples bscCI(100,25,0.95,digits = 3)
#' 
#' @export bscCI
bscCI <- function(n_tot, n_suc, conf, digits = 2) {
  
  stopifnot(n_tot >= 0 && n_suc >= 0 && n_tot >= n_suc)
  stopifnot(conf > 0 && conf < 1)
  
  bsc_ci <- .bscCI(n_tot, n_suc, conf)
  if (!missing(digits)) {
    round(bsc_ci, digits)
  }
  else {
    return(bsc_ci)
  }
}