Skip to contents

Mean and Standard deviation

Source: R/mean_sd.R
mean_sd.Rd

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

character string with value "latex" or "markdown"

...

pass through

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. Formatting of the output will be extended in future versions.

See also

gmean_sd, n_perc, median_iqr

Examples

set.seed(42)
x <- rnorm(1000, 3, 4)
mean(x)
#> [1] 2.896702
sd(x)
#> [1] 4.010085
mean_sd(x)
#> [1] "2.90 $\\pm$ 4.01"
mean_sd(x, show_n = "always")
#> [1] "1,000; 2.90 $\\pm$ 4.01"
mean_sd(x, show_n = "always", denote_sd = "paren")
#> [1] "1,000; 2.90 (4.01)"

x[187] <- NA
mean_sd(x, na_rm = TRUE)
#> [1] "999; 2.89 $\\pm$ 4.01"