% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/easy_nonparametric.R
\name{easy_wilcox}
\alias{easy_wilcox}
\title{Wilcoxon Tests with Automated Narrative Reporting}
\usage{
easy_wilcox(
  x,
  y = NULL,
  data = NULL,
  mu = 0,
  paired = FALSE,
  alternative = "two.sided",
  conf_level = 0.95,
  alpha = 0.05
)
}
\arguments{
\item{x}{Numeric vector, or a formula of the form \code{outcome ~ group}.}

\item{y}{Optional numeric vector for paired or two-sample tests.}

\item{data}{Data frame used when \code{x} is a formula.}

\item{mu}{Null hypothesized location or location shift. Default \code{0}.}

\item{paired}{Logical. Use paired test? Default \code{FALSE}.}

\item{alternative}{\code{"two.sided"}, \code{"less"}, or \code{"greater"}.}

\item{conf_level}{Confidence level. Default \code{0.95}.}

\item{alpha}{Significance threshold for narrative. Default \code{0.05}.}
}
\value{
An \code{"easystat_result"} object.
}
\description{
Runs a one-sample, paired, or two-sample Wilcoxon test using
\code{stats::wilcox.test()} and returns an \code{"easystat_result"} object.
}
\examples{
result <- easy_wilcox(mpg ~ am, data = mtcars)
print(result)

}
