% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/easy_ftest.R
\name{easy_ftest}
\alias{easy_ftest}
\title{F-Test for Equality of Variances with Automated Narrative Reporting}
\usage{
easy_ftest(
  x,
  y = NULL,
  data = NULL,
  ratio = 1,
  alternative = "two.sided",
  conf_level = 0.95,
  alpha = 0.05
)
}
\arguments{
\item{x}{A numeric vector (Group 1), OR a formula \code{outcome ~ group}.}

\item{y}{A numeric vector (Group 2). Ignored when \code{x} is a formula.}

\item{data}{A data frame. Required when \code{x} is a formula.}

\item{ratio}{Hypothesized ratio of variances under H0. Default \code{1}.}

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

\item{conf_level}{Confidence level for the variance ratio CI. Default \code{0.95}.}

\item{alpha}{Significance threshold for narrative. Default \code{0.05}.}
}
\value{
An \code{"easystat_result"} object.
}
\description{
Performs an F-test to compare the variances of two independent groups using
\code{stats::var.test()}, extracts the F-statistic, degrees of freedom,
p-value, variance ratio, and confidence interval, and generates a
plain-language narrative that includes a practical recommendation for
downstream t-test selection (equal vs. unequal variances).
}
\examples{
result <- easy_ftest(mpg ~ am, data = mtcars)
print(result)

}
