Returns the names of every metric that the descriptive-statistics summary tables can display, i.e. the values accepted by the metrics argument of summary tables such as tableContinuousCovariateSummary(), tableNCAParameters() and tableNCARatios(). The names are returned in the exact order the metrics are computed: first the per-group statistics, then the combined display metrics.
Usage
getDescriptiveStatsMetrics()
Arguments
This function takes no arguments.
Return: A character vector of available metric names, in calculation order:
Per-group statistics
-
N- number of subjects (unique IDs) -
Nobs- number of observations -
min- minimum -
P05- 5th percentile -
Q1- first quartile (25th percentile) -
mean- arithmetic mean -
SD- standard deviation -
SE- standard error of the mean -
CV- coefficient of variation (%) -
median- median (50th percentile) -
Q3- third quartile (75th percentile) -
P95- 95th percentile -
max- maximum -
geoMean- geometric mean -
geoSD- geometric standard deviation -
geoCV- geometric coefficient of variation (%) -
harmMean- harmonic mean
Combined display metrics
-
MeanSD- arithmetic mean with SD, shown as "Arithmetic Mean (SD)" -
MeanCV- arithmetic mean with CV%, shown as "Arithmetic Mean (CV %)" -
GeomCV- geometric mean with geometric CV%, shown as "Geometric Mean (CV %)" -
GeomSD- geometric mean with geometric SD, shown as "Geometric Mean (SD)"
Examples
List all available metrics
getDescriptiveStatsMetrics()
#> [1] "N" "Nobs" "min" "P05" "Q1" "mean" "SD"
#> [8] "SE" "CV" "median" "Q3" "P95" "max" "geoMean"
#> [15] "geoSD" "geoCV" "harmMean" "MeanSD" "MeanCV" "GeomCV" "GeomSD"