R/statease-package.R

In statease: Simplified Statistical Analysis with Plain-English Interpretation

#' statease: Simplified Statistical Analysis with Plain-English Interpretation
#'
#' @description
#' statease provides a suite of functions for performing common statistical
#' analyses and automatically interpreting the results in plain English.
#' It is designed for students, researchers, and educators who want fast,
#' readable statistical output without sacrificing rigour.
#'
#' @section Main Functions:
#' \describe{
#'   \item{\code{\link{analyze}}}{Master function — auto-detects and runs the right test}
#'   \item{\code{\link{describe}}}{Descriptive statistics with interpretation}
#'   \item{\code{\link{ttest_interpret}}}{T-tests (one-sample, independent, paired) with Cohen's d}
#'   \item{\code{\link{anova_interpret}}}{One-way ANOVA with Tukey post-hoc and eta squared}
#'   \item{\code{\link{interpret_p}}}{Standalone p-value interpreter}
#' }
#'
#' @section Typical Workflow:
#' The simplest way to use statease is through the master \code{analyze()}
#' function, which automatically detects what test to run based on your input:
#'
#' \preformatted{
#' # Descriptive statistics
#' analyze(x = my_vector, var_name = "My Variable")
#'
#' # Independent samples t-test
#' analyze(x = group1, y = group2, var_name = "Scores")
#'
#' # One-way ANOVA
#' analyze(formula = score ~ group, data = my_df)
#'
#' # Interpret a p-value
#' interpret_p(0.03, context = "treatment vs control")
#' }
#'
#' @author Uwakmfon Usen Paul
#'
#' @importFrom stats IQR TukeyHSD aov bartlett.test median na.omit quantile sd shapiro.test t.test var.test chisq.test cor.test lm confint confint.default residuals fitted pf coef glm binomial pchisq manova wilcox.test kruskal.test qnorm summary.aov contr.sum
#' @importFrom utils combn
#' @docType package
#' @name statease
"_PACKAGE"