pubprint (version 0.2.1)

style.apa.character: Formats a character vector

Description

This style functions takes character vectors in a list and returns it unlisted. This is mainly for putting math mode and brackets around the character vector using pprint, but may be used to replace identifier names in character vectors as well.

Usage

style.apa.character(x, as.identifier = FALSE, replace = TRUE)

Arguments

x

a list. All list items have to be character vectors.

as.identifier

a logical. If TRUE character vector is handled as identifiers (this is mainly for special treatment in HTML output mode).

replace

a logical, specifying whether identifiers are replaced with more proper names (e.g. R^2 will be written in proper output format or cor is replaced with r).

Value

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

Other APA.style.functions: style.apa.anova, style.apa.bartlett, 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, style.apa.t.test

Examples

pprint(c("test 1", "test 2"), format="character")