R/table.dist.hypergeometric.R

Defines functions table.dist.hypergeometric

Documented in table.dist.hypergeometric

#' Table of Hypergeometric Distribution  
#' 
#' Calculates probabilities for the hypergeometric distribution and includes cumulative probabilities from each tail.
#'
#' @param pop.success.count Scalar - Total "successes" in population 
#' @param total.count Scalar - Total population size
#' @param sample.size Scaler - How many items are sampled 
#'
#' @return A data frame with x, probability at x, and cumulative probability from each tail to x. 
table.dist.hypergeometric <- function( 
  pop.success.count
  ,total.count
  ,sample.size
) {
  
  m <- pop.success.count
  n <- total.count - m
  
  d              <- data.frame(x=0:sample.size)
  d$p.at.x       <- dhyper(0:sample.size, m = m, n = n, k = sample.size)
  d$eq.and.above <- phyper(0:sample.size, m = m, n = n, k = sample.size, lower.tail = F) + d$p.at.x
  d$eq.and.below <- phyper(0:sample.size, m = m, n = n, k = sample.size)
  
  rownames(d) <- d$x
  names(d)[1] <- "success.count"
  
  d
}
burrm/lolcat documentation built on Sept. 15, 2023, 11:35 a.m.