fmt_median: Formatted Median

Description Usage Arguments Details Value See Also Examples

View source: R/helpers.R

Description

A function to calculate and format a median.

Usage

1
fmt_median(x, format = "%.1f")

Arguments

x

The input data vector or data frame column.

format

A formatting string suitable for input into the sprintf function. By default, this format is defined as "%.1f", which displays the value with one decimal place.

Details

This function calculates a median using the stats package median function, and then formats the output using sprintf. You may control the format using the format parameter. Function will ignore any NA values in the input data. Results are returned as a character vector.

Value

The formatted median value.

See Also

Other helpers: fmt_cnt_pct(), fmt_mean_sd(), fmt_n(), fmt_quantile_range(), fmt_range()

Examples

1
2
3
4
5
6
7
v1 <- c(4.3, 3.7, 8.7, 6.1, 9.2, 5.6, NA, 0.7, 7.8, 4.9)

# Format median
fmt_median(v1)

# Output
# "5.6"

fmtr documentation built on June 21, 2021, 9:06 a.m.