qwraps2 (version 0.1.2)

mean_sd: Mean and Standard deviation

Description

A function for calculating and formatting means and standard deviations.

Usage

mean_sd(x, digits = getOption("qwraps2_frmt_digits", 2), na_rm = FALSE,
  show_n = "ifNA", denote_sd = "pm", markup = getOption("qwraps2_markup",
  "latex"))

Arguments

x

a numeric vector

digits

digits to the right of the decimal point to return in the percentage estimate.

na_rm

if true, omit NA values

show_n

defaults to "ifNA". Other options are "always" or "never".

denote_sd

a character string set to either "pm" or "paren" for reporting 'mean $\pm$ sd' or 'mean (sd)'

markup

latex or markdown

Value

• a character vector of the formatted values

Details

Given a numeric vector, mean_sd will return a character string with the mean and standard deviation. Formating of the output will be extended in future versions.

Examples

set.seed(42)
x <- rnorm(1000, 3, 4)
mean(x)
sd(x)
mean_sd(x)
mean_sd(x, show_n = "always")
mean_sd(x, show_n = "always", denote_sd = "paren")

x[187] <- NA
mean_sd(x, na_rm = TRUE)