format_pairwise_comparison: Format results of a pairwise comparison

View source: R/format_strings.R

format_pairwise_comparisonR Documentation

Format results of a pairwise comparison

Description

This function takes the results of a pairwise comparison and formats it for easy markdown outputs

Usage

format_pairwise_comparison(
  t_stat,
  df,
  p_val,
  mdiff = "none",
  lci = "none",
  uci = "none",
  cohen_d = "none",
  as.markdown = T
)

Arguments

t_stat

t-statistic

df

degrees of freedom

p_val

p-value of t-statistic

mdiff

optional, the mean difference of the comparison

lci

optional, the lower end of the confidence interval on the comparison

uci

optional, the upper end of the confidence interval on the comparison

cohen_d

optional, Cohen's d standardized effect size

as.markdown

optional, indicates whether the resulting string should be formatted for markdown. Default is TRUE

Value

A formatted t-statistic


silverer/statstring documentation built on Aug. 6, 2023, 11:48 a.m.