apa: APA Format

In petersenlab: A Collection of R Functions by the Petersen Lab

APA Format

Description

Format decimals and leading zeroes. Adapted from the MOTE package.

Usage

apa(value, decimals = 3, leading = TRUE)

Arguments

value	A set of numeric values, either a single number, vector, or set of columns.
decimals	The number of decimal points desired in the output.
leading	Logical value: TRUE for leading zeroes on decimals and FALSE for no leading zeroes on decimals. The default is TRUE.

Details

Formats decimals and leading zeroes for creating reports in scientific style, to be consistent with American Psychological Association (APA) format. This function creates "pretty" character vectors from numeric variables for printing as part of a report. The value can take a single number, matrix, vector, or multiple columns from a data frame, as long as they are numeric. The values will be coerced into numeric if they are characters or logical values, but this process may result in an error if values are truly alphabetical.

Value

Value(s) in the format specified, with the number of decimals places indicated and with or without a leading zero, as indicated.

See Also

https://github.com/doomlab/MOTE

Other formatting: pValue(), specify_decimal(), suppressLeadingZero()

Examples

apa(value = 0.54674, decimals = 3, leading = TRUE)

petersenlab documentation built on April 4, 2025, 12:22 a.m.