default_stats_formats_labels {tern} | R Documentation |
Get default statistical methods and their associated formats, labels, and indent modifiers
Description
Utility functions to get valid statistic methods for different method groups
(.stats
) and their associated formats (.formats
), labels (.labels
), and indent modifiers
(.indent_mods
). This utility is used across tern
, but some of its working principles can be
seen in analyze_vars()
. See notes to understand why this is experimental.
Usage
get_stats(
method_groups = "analyze_vars_numeric",
stats_in = NULL,
custom_stats_in = NULL,
add_pval = FALSE
)
get_stat_names(stat_results, stat_names_in = NULL)
get_formats_from_stats(
stats,
formats_in = NULL,
levels_per_stats = NULL,
tern_defaults = tern_default_formats
)
get_labels_from_stats(
stats,
labels_in = NULL,
levels_per_stats = NULL,
label_attr_from_stats = NULL,
tern_defaults = tern_default_labels
)
get_indents_from_stats(
stats,
indents_in = NULL,
levels_per_stats = NULL,
tern_defaults = as.list(rep(0L, length(stats))) %>% setNames(stats),
row_nms = lifecycle::deprecated()
)
tern_default_stats
tern_default_formats
tern_default_labels
summary_formats(type = "numeric", include_pval = FALSE)
summary_labels(type = "numeric", include_pval = FALSE)
Arguments
method_groups |
( |
stats_in |
( |
custom_stats_in |
( |
add_pval |
( |
stat_results |
( |
stat_names_in |
( |
stats |
( |
formats_in |
(named |
levels_per_stats |
(named |
tern_defaults |
( |
labels_in |
(named |
label_attr_from_stats |
(named |
indents_in |
(named |
row_nms |
|
type |
( |
include_pval |
( |
Format
-
tern_default_stats
is a named list of available statistics, with each element named for their corresponding statistical method group.
-
tern_default_formats
is a named vector of available default formats, with each element named for their corresponding statistic.
-
tern_default_labels
is a namedcharacter
vector of available default labels, with each element named for their corresponding statistic.
Details
Current choices for type
are counts
and numeric
for analyze_vars()
and affect get_stats()
.
summary_*
quick get functions for labels or formats uses get_stats
and get_labels_from_stats
or
get_formats_from_stats
respectively to retrieve relevant information.
Value
-
get_stats()
returns acharacter
vector of statistical methods.
-
get_stat_names()
returns a named list ofcharacter
vectors, indicating the names of statistical outputs.
-
get_formats_from_stats()
returns a named list of formats as strings or functions.
-
get_labels_from_stats()
returns a named list of labels as strings.
-
get_indents_from_stats()
returns a named list of indentation modifiers as integers.
-
summary_formats()
returns a namedvector
of default statistic formats for the given data type.
-
summary_labels
returns a namedvector
of default statistic labels for the given data type.
Functions
-
get_stats()
: Get statistics available for a given method group (analyze function). To check available defaults seetern::tern_default_stats
list. -
get_stat_names()
: Get statistical names available for a given method group (analyze function). Please use thes_*
functions to get the statistical names. -
get_formats_from_stats()
: Get formats corresponding to a list of statistics. To check available defaults see listtern::tern_default_formats
. -
get_labels_from_stats()
: Get labels corresponding to a list of statistics. To check for available defaults see listtern::tern_default_labels
. -
get_indents_from_stats()
: Get row indent modifiers corresponding to a list of statistics/rows. -
tern_default_stats
: Named list of available statistics by method group fortern
. -
tern_default_formats
: Named vector of default formats fortern
. -
tern_default_labels
: Namedcharacter
vector of default labels fortern
. -
summary_formats()
: Quick function to retrieve default formats for summary statistics:analyze_vars()
andanalyze_vars_in_cols()
principally. -
summary_labels()
: Quick function to retrieve default labels for summary statistics. Returns labels of descriptive statistics which are understood byrtables
. Similar tosummary_formats
.
Note
These defaults are experimental because we use the names of functions to retrieve the default statistics. This should be generalized in groups of methods according to more reasonable groupings.
Formats in tern
and rtables
can be functions that take in the table cell value and
return a string. This is well documented in vignette("custom_appearance", package = "rtables")
.
See Also
Examples
# analyze_vars is numeric
num_stats <- get_stats("analyze_vars_numeric") # also the default
# Other type
cnt_stats <- get_stats("analyze_vars_counts")
# Weirdly taking the pval from count_occurrences
only_pval <- get_stats("count_occurrences", add_pval = TRUE, stats_in = "pval")
# All count_occurrences
all_cnt_occ <- get_stats("count_occurrences")
# Multiple
get_stats(c("count_occurrences", "analyze_vars_counts"))
stat_results <- list(
"n" = list("M" = 1, "F" = 2),
"count_fraction" = list("M" = c(1, 0.2), "F" = c(2, 0.1))
)
get_stat_names(stat_results)
get_stat_names(stat_results, list("n" = "argh"))
# Defaults formats
get_formats_from_stats(num_stats)
get_formats_from_stats(cnt_stats)
get_formats_from_stats(only_pval)
get_formats_from_stats(all_cnt_occ)
# Addition of customs
get_formats_from_stats(all_cnt_occ, formats_in = c("fraction" = c("xx")))
get_formats_from_stats(all_cnt_occ, formats_in = list("fraction" = c("xx.xx", "xx")))
# Defaults labels
get_labels_from_stats(num_stats)
get_labels_from_stats(cnt_stats)
get_labels_from_stats(only_pval)
get_labels_from_stats(all_cnt_occ)
# Addition of customs
get_labels_from_stats(all_cnt_occ, labels_in = c("fraction" = "Fraction"))
get_labels_from_stats(all_cnt_occ, labels_in = list("fraction" = c("Some more fractions")))
get_indents_from_stats(all_cnt_occ, indents_in = 3L)
get_indents_from_stats(all_cnt_occ, indents_in = list(count = 2L, count_fraction = 5L))
get_indents_from_stats(
all_cnt_occ,
indents_in = list(a = 2L, count.a = 1L, count.b = 5L)
)
summary_formats()
summary_formats(type = "counts", include_pval = TRUE)
summary_labels()
summary_labels(type = "counts", include_pval = TRUE)