R/conf-package.R

In conf: Visualization and Analysis of Statistical Measures of Confidence

#' conf: Visualization and Analysis of Statistical Measures of Confidence
#'
#' @description
#' Enables:
#' \enumerate{
#' \item confidence region plots in two-dimensions corresponding to a user given dataset,
#' level of significance, and parametric probability distribution (supported distribution suffixes:
#' cauchy, gamma, invgauss, lnorm, llogis, logis, norm, unif, weibull),
#' \item coverage simulations (if a point of interest is within or outside of a confidence region
#' boundary) for either random samples drawn from a user-specified parametric distribution or for a
#' user-specified dataset and point of interest,
#' \item calculating confidence intervals and the associated actual coverage for binomial proportions, and
#' \item calculating the support values and the probability mass function of the Kaplan-Meier product-limit
#' estimator.
#' \item plotting the actual coverage function for a randomly right-censored data set with exponential
#' failure times and exponential censoring times.
#' }
#'
#' \bold{Request from authors}:  Please properly cite any use of this package and/or its algorithms,
#' which are detailed in the corresponding publication by Weld et al. (2018)
#' <doi:10.1080/00031305.2018.1564696>, Park and Leemis (2019) <doi:10.1002/sim.8189>,
#' Feng et al. (2022) <doi:10.1007/s00180-021-01183-3>, and Qin et al. (2023)
#' <doi:10.1080/00031305.2022.2070279>.  Additionally, we welcome and appreciate your feedback and
#' insights as to how this resource is being leveraged to improve whatever it is you do.  Please
#' include your name and academic and/or business affiliation in your correspondence.
#'
#' @details
#' This package includes the functions:
#' \itemize{
#' \item confidence intervals for binomial proportions: \code{\link{binomTest}},
#' \item actual coverage calculation for binomial proportions: \code{\link{binomTestCoverage}},
#' \item actual coverage plots for binomial proportions: \code{\link{binomTestCoveragePlot}},
#' \item ensemble confidence intervals for binomial proportions: \code{\link{binomTestEnsemble}},
#' \item minimum root mean square confidence intervals for binomial proportions: \code{\link{binomTestMSE}},
#' \item confidence region coverage analysis: \code{\link{coversim}},
#' \item confidence region plots: \code{\link{crplot}},
#' \item actual coverage plot and table: \code{\link{km.coverage}},
#' \item enumeration of Kaplan-Meier product-limit estimator outcomes: \code{\link{km.outcomes}},
#' \item probability mass function of the Kaplan-Meier product-limit estimator: \code{\link{km.pmf}},
#' \item Kaplan-Meier product-limit estimator support values: \code{\link{km.support}}, and
#' \item probability mass functions of the Kaplan-Meier product-limit estimator: \code{\link{km.surv}}.
#' }
#'
#' @section Vignettes:
#' The CRAN website https://CRAN.R-project.org/package=conf contains links for vignettes on the
#' \code{\link{crplot}}, \code{\link{coversim}}, \code{\link{km.outcomes}}, \code{\link{km.pmf}}, \code{\link{km.support}},
#' and \code{\link{km.surv}} functions.
#'
#' @section Acknowledgments:
#' The lead author thanks The Omar Bradley Fellowship for Research in Mathematics for funding that partially
#' supported this work.
#'
#' @author
#' Christopher Weld, Kexin Feng, Hayeon Park, Yuxin Qin, Xingyu Wang, Heather Sasinowska, Larry Leemis
#'
#' Maintainer: Christopher Weld <ceweld241@gmail.com>
#'
#' @aliases conf-package
#' @docType package
#' @name conf

NULL