View source: R/get_test_label.R
get_pwc_label | R Documentation |
Extracts label information from statistical tests. Useful for labelling plots with test outputs.
get_pwc_label(stat.test, type = c("expression", "text")) get_test_label( stat.test, description = NULL, p.col = "p", type = c("expression", "text"), correction = c("auto", "GG", "HF", "none"), row = NULL, detailed = FALSE ) create_test_label( statistic.text, statistic, p, parameter = NA, description = NULL, n = NA, effect.size = NA, effect.size.text = NA, type = c("expression", "text"), detailed = FALSE ) get_n(stat.test) get_description(stat.test)
stat.test |
statistical test results returned by |
type |
the label type. Can be one of "text" and "expression". Partial
match allowed. If you want to add the label onto a ggplot, it might be
useful to specify |
description |
the test description used as the prefix of the label.
Examples of description are "ANOVA", "Two Way ANOVA". To remove the default
description, specify |
p.col |
character specifying the column containing the p-value. Default
is |
correction |
character, considered only in the case of ANOVA test. Which sphericity
correction of the degrees of freedom should be reported for the
within-subject factors (repeated measures). The default is set to
|
row |
numeric, the row index to be considered. If NULL, the last row is automatically considered for ANOVA test. |
detailed |
logical value. If TRUE, returns detailed label. |
statistic.text |
character specifying the test statistic. For example
|
statistic |
the numeric value of a statistic. |
p |
the p-value of the test. |
parameter |
string containing the degree of freedom (if exists). Default
is |
n |
sample count, example: |
effect.size |
the effect size value |
effect.size.text |
a character specifying the relevant effect size. For
example, for |
a text label or an expression to pass to a plotting function.
get_pwc_label()
: Extract label from pairwise comparisons.
get_test_label()
: Extract labels for statistical tests.
create_test_label()
: Create labels from user specified test results.
get_n()
: Extracts sample counts (n) from an rstatix test outputs. Returns a numeric vector.
get_description()
: Extracts the description of an rstatix test outputs. Returns a character vector.
# Load data #::::::::::::::::::::::::::::::::::::::: data("ToothGrowth") df <- ToothGrowth # One-way ANOVA test #::::::::::::::::::::::::::::::::::::::::: anov <- df %>% anova_test(len ~ dose) get_test_label(anov, detailed = TRUE, type = "text") # Two-way ANOVA test #::::::::::::::::::::::::::::::::::::::::: anov <- df %>% anova_test(len ~ supp*dose) get_test_label(anov, detailed = TRUE, type = "text", description = "Two Way ANOVA") # Kruskal-Wallis test #::::::::::::::::::::::::::::::::::::::::: kruskal<- df %>% kruskal_test(len ~ dose) get_test_label(kruskal, detailed = TRUE, type = "text") # Wilcoxon test #::::::::::::::::::::::::::::::::::::::::: # Unpaired test wilcox <- df %>% wilcox_test(len ~ supp) get_test_label(wilcox, detailed = TRUE, type = "text") # Paired test wilcox <- df %>% wilcox_test(len ~ supp, paired = TRUE) get_test_label(wilcox, detailed = TRUE, type = "text") # T test #::::::::::::::::::::::::::::::::::::::::: ttest <- df %>% t_test(len ~ dose) get_test_label(ttest, detailed = TRUE, type = "text") # Pairwise comparisons labels #::::::::::::::::::::::::::::::::::::::::: get_pwc_label(ttest, type = "text") # Create test labels #::::::::::::::::::::::::::::::::::::::::: create_test_label( statistic.text = "F", statistic = 71.82, parameter = "4, 294", p = "<0.0001", description = "ANOVA", type = "text" ) # Extract infos #::::::::::::::::::::::::::::::::::::::::: stat.test <- df %>% t_test(len ~ dose) get_n(stat.test) get_description(stat.test)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.