Report the mean and standard deviation of a dependent variable for all levels of an independent variable rounded to the 2nd digit.

#' To easily copy and paste the results to your manuscript, the following commands must be defined in Latex: \newcommand{\m}{\textit{M=}} \newcommand{\sd}{\textit{SD=}}

Usage

reportMeanAndSD(data, iv = "testiv", dv = "testdv", sink_to = NULL)

report_mean_sd(data, iv = "testiv", dv = "testdv", sink_to = NULL)

Arguments

data

the data frame

iv

the independent variable

dv

the dependent variable

sink_to

optional path of a .tex file to write the lines to, so a manuscript can \input{} them

Value

Invisibly returns the formatted lines as a character vector; the text is also emitted via message().

Naming

report_mean_sd() is the spelling used throughout the documentation and the one to prefer in new code: the report_* / plot_* / check_* prefixes make the API discoverable through autocomplete.

reportMeanAndSD() is the original name. Both names refer to the same function object, so they are entirely interchangeable; the original remains fully supported and is not scheduled for removal, and existing scripts keep working unchanged.

Examples

# \donttest{

example_data <- data.frame(Condition = rep(c("A", "B", "C"),
each = 10), TLX1 = stats::rnorm(30))

reportMeanAndSD(example_data, iv = "Condition", dv = "TLX1")
#> %A: \m{0.12}, \sd{0.94}
#> %B: \m{-0.36}, \sd{1.00}
#> %C: \m{0.31}, \sd{0.55}
# }