style.apa.fisher: Formats a Fisher's Exact Test

Description

This style functions takes a Fisher's exact test in a list and transforms it into a formatted character vector. Odds ratio is printed optionally.

Usage

style.apa.fisher(x, print.estimate = TRUE, estimate.names = names(x[[1]]$estimate))

Arguments

a list. First item must be a Fisher's exact test (htest class). All other list items will be ignored.

print.estimate

a logical, indicating whether odds ratio is printed as well.

estimate.names

a character vector, giving a alternative name for "odds ratio".

Value

character vector with a formatted character vector.

Details

Please note that this is a internal style function. It is called from pprint and not exported to user namespace. Usually pprint determines the correct style function automatically, but you can define the style function by using the format argument of pprint (pass the name of this function without style.apa. prefix). Additionally you can pass the arguments listed in this documentation to pprint.

Argument x of this function expects a list. Be aware that you do not have to pass a list to pprint or pull.pubprint -- these functions will convert your arguments. This is only necessary if you want to pass additionally information to the internal style functions (see vignette for examples).

Examples

Run this code

pprint(t.test(1:30, 2:31), format = "t.test")
pprint(t.test(1:30, 2:31), format = "t.test", print.estimate = FALSE)
pprint(t.test(1:30, 2:31), 
       format = "t.test", 
       estimate.names = c("control", "treatment"))
TeaTasting <-
matrix(c(3, 1, 1, 3),
       nrow = 2,
       dimnames = list(Guess = c("Milk", "Tea"),
                       Truth = c("Milk", "Tea")))
pprint(fisher.test(TeaTasting, alternative = "greater"),
       format = "fisher")
pprint(fisher.test(TeaTasting, alternative = "greater"),
       format = "fisher",
       print.estimate = FALSE)

Run the code above in your browser using DataLab