chisq.test: Apply 'stats::chisq.test()' to a two-way tabyl

In sfirke/janitor: Simple Tools for Examining and Cleaning Dirty Data

Apply stats::chisq.test() to a two-way tabyl

Description

This generic function overrides stats::chisq.test. If the passed table is a two-way tabyl, it runs it through janitor::chisq.test.tabyl, otherwise it just calls stats::chisq.test().

Usage

chisq.test(x, ...)

## Default S3 method:
chisq.test(x, y = NULL, ...)

## S3 method for class 'tabyl'
chisq.test(x, tabyl_results = TRUE, ...)

Arguments

x	a two-way tabyl, a numeric vector or a factor
...	other parameters passed to stats::chisq.test()
y	if x is a vector, must be another vector or factor of the same length
tabyl_results	If TRUE and x is a tabyl object, also return observed, expected, residuals and stdres as tabyl.

Value

The result is the same as the one of stats::chisq.test(). If tabyl_results is TRUE, the returned tables observed, expected, residuals and stdres are converted to tabyls.

Examples

tab <- tabyl(mtcars, gear, cyl)
chisq.test(tab)
chisq.test(tab)$residuals

sfirke/janitor documentation built on Dec. 23, 2024, 6:31 p.m.