RplotterPkg (version 0.1.3)

percentile_table: percentile_table

Description

Function locates values corresponding to percentiles in a vector of numeric data. Function displays a table with lower/upper locations, values, average and spread between lower/upper from median to one hundred and twenty-eighth percentiles. The function returns a list with a viewable gt table along with the data.table containing the table's values.

The "label" column of the table correspond to the following percentiles:

1. "M" = Half (i.e. the median)

2. "F" = Fourth (i.e. quartiles 25/75)

3. "E" = Eighth

4. "D" = Sixteenth

5. "C" = Thirty-secondth

6. "B" = Sixty-fourth

7. "A" = One hundred and twenty-eighth

Usage

percentile_table(vals = NULL, na_rm = TRUE, title = NULL, table_width = NULL)

Value

A named list with a gt object and a data.table with percentile values contained in the display table.

Arguments

vals

A required vector of numeric values

na_rm

A logical which if TRUE removes NA values before the calculations

title

A string that sets the table's title. The string can contain R markdown/html style syntax.

table_width

A numeric that sets the overall table width in pixels.

Examples

library(gt)
library(data.table)
library(RplotterPkg)

set.seed(12345)
random_vals <- stats::rnorm(n = 1000, mean = 20, sd = 4)
percentile_random_lst <- RplotterPkg::percentile_table(
  vals = random_vals
)
percentile_random_lst$table_gt