R/visualize.pois.R

In visualize: Graph Probability Distributions with User Supplied Parameters and Statistics

#' Visualize Poisson Distribution
#' 
#' Generates a plot of the Poisson distribution with user specified parameters.
#' 
#' 
#' @param stat a statistic to obtain the probability from. When using the
#' "bounded" condition, you must supply the parameter as `stat =
#' c(lower_bound, upper_bound)`. Otherwise, a simple `stat =
#' desired_point` will suffice.
#' @param lambda lambda value of the Poisson Distribution.
#' @param section Select how you want the statistic(s) evaluated via
#' `section=` either `"lower"`,`"bounded"`, `"upper"`,
#' or`"tails"`.
#' @param strict Determines whether the probability will be generated as a
#' strict (<, >) or equal to (<=, >=) inequality. `strict=` requires
#' either values = 0 or =FALSE for equal to OR values =1 or =TRUE for strict.
#' For bounded condition use: `strict=c(0,1)` or
#' `strict=c(FALSE,TRUE)`.
#' @author James Balamuta
#' @export
#' @seealso [visualize.it()] , [dpois()].
#' @keywords visualize
#' @examples
#' 
#' # Evaluates lower tail.
#' visualize.pois(stat = 1, lambda = 2, section = "lower", strict = FALSE) 
#' 
#' # Evaluates bounded region.
#' visualize.pois(stat = c(1,3), lambda = 3, section = "bounded", strict = c(0,1))
#' 
#' # Evaluates upper tail.
#' visualize.pois(stat = 1, lambda = 2, section = "upper", strict = 1)
#' 
visualize.pois <-
function(stat = 1, lambda = 3.5, section = "lower", strict = FALSE) {
  visualize.it('pois', stat = stat, list(lambda = lambda), section = section, strict=strict)
}