gmean_sd {qwraps2} | R Documentation |
Geometric Mean and Standard deviation
Description
A function for calculating and formatting geometric means and standard deviations.
Usage
gmean_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
|
markup |
character string with value “latex” or “markdown” |
... |
pass through |
Details
Given a numeric vector, gmean_sd
will return a character string with
the geometric mean and standard deviation. Formatting of the output will be
extended in future versions.
Value
a character vector of the formatted values
See Also
Examples
gmean_sd(mtcars$mpg, markup = "latex")
gmean_sd(mtcars$mpg, markup = "markdown")
[Package qwraps2 version 0.6.0 Index]