chisq.stars: Graphical interpretation of the chi-square test p-value

Description Usage Arguments Details Value See Also Examples

View source: R/stats.R

Description

Returns a graphical interpretation of the chi-square test p-value

Usage

1
2
3
4
5
6
7
8
9
chisq.stars(
  x,
  y = NULL,
  correct = TRUE,
  p = rep(1/length(x), length(x)),
  rescale.p = FALSE,
  simulate.p.value = FALSE,
  B = 2000
)

Arguments

x

a numeric vector or matrix. x and y can also both be factors.

y

a numeric vector; ignored if x is a matrix. If x is a factor, y should be a factor of the same length

correct

a logical indicating whether to apply continuity correction when computing the test statistic for 2 by 2 tables: one half is subtracted from all |O - E| differences; however, the correction will not be bigger than the differences themselves. No correction is done if simulate.p.value = TRUE.

p

a vector of probabilities of the same length of x. An error is given if any entry of p is negative.

rescale.p

a logical scalar; if TRUE then p is rescaled (if necessary) to sum to 1. If rescale.p is FALSE, and p does not sum to 1, an error is given.

simulate.p.value

a logical indicating whether to compute p-values by Monte Carlo simulation.

B

an integer specifying the number of replicates used in the Monte Carlo test.

Details

The function returns a graphical interpretation of a chi-square test p-value, under the form of a variable number of asterisks : (ns) means p >= 0.05; * means p < 0.05; ** means p < 0.01 ; *** means p < 0.001.

Value

A character vector.

See Also

chisq.test

Examples

1
2
3
4
5
## From Agresti(2007) p.39
M <- as.table(rbind(c(762, 327, 468), c(484, 239, 477)))
dimnames(M) <- list(gender = c("F", "M"), party = c("Democrat","Independent", "Republican"))
chisq.test(M))  # Prints test summary with chisq.test() function
chisq.stars(M) # Prints graphical test summary with stars

pmerckle/datatools documentation built on Feb. 21, 2022, 2:19 a.m.