plot_esci_test: visual display of a hypothesis test on a linear contrast of...

Description Usage Arguments Value

View source: R/esci_testing.R

Description

visual display of a hypothesis test on a linear contrast of means

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
plot_esci_test(
  estimate,
  rope_lower = -0.1,
  rope_upper = 0.1,
  rope_units = c("sd", "raw"),
  alpha = 0.05,
  error_layout = c("halfeye", "eye", "gradient", "none"),
  error_scale = 0.3,
  error_normalize = c("groups", "all", "panels"),
  ggtheme = ggplot2::theme_classic()
)

Arguments

estimate
  • must be an esci_estimate object generated by estimate_mdiff_contrast_bs

rope_lower
  • numeric lower limit of the region of practical equivalence (rope)

rope_upper
  • numeric upper limit of the rope

rope_units
  • conduct test on original units (raw) or sds (cohen's d); defaults to raw

alpha
  • alpha level to use for evaluation

error_layout
  • optional, tells shape to use for expected error distribution: halfeye (default), eye, gradient, or none

error_scale
  • optional number giving width allocated to expected error distribution

error_normalize
  • optional; the way error distribution height is normalized in the graph: groups (default), all, panels

ggtheme
  • an optional ggtheme object to apply to the graph. Defaults to theme_classic

Value

Returns an ggplot2 object


rcalinjageman/esci2 documentation built on Dec. 22, 2021, 1:02 p.m.