pubprint (version 0.2.1)

style.apa.t.test: Formats a t-test

Description

This style functions takes a t-test in a list and transforms it into a formatted character vector. Estimates are printed as well.

Usage

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

Arguments

x

a list. First item must be a t-test (htest class). Second item is optional and may contain an effect size (numeric). All other list items will be ignored.

print.estimate

a logical, indicating whether estimates are printed as well.

estimate.names

a character vector, giving the names of the estimates.

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).

See Also

t.test

Other APA.style.functions: style.apa.anova, style.apa.bartlett, style.apa.character, style.apa.chisq, style.apa.cor.test, style.apa.df, style.apa.fisher, style.apa.ks, style.apa.numeric, style.apa.p.value, style.apa.shapiro, style.apa.summary.aovlist, style.apa.summary.lm.beta.coeff, style.apa.summary.lm.coeff, style.apa.summary.lm.equation, style.apa.summary.lm.model

Examples

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"))