apa_planned_comparisons_writeup

APA Write-Up for Planned Comparisons (Between-Groups)

Description

Generates an APA-style paragraph for planned t-test comparisons against a reference group, without omnibus F-test.

Usage

apa_planned_comparisons_writeup(
  planned_results_list,
  dv_name,
  reference_group,
  comparison_groups,
  hypothesis = NULL,
  alpha = 0.05,
  include_effect_size = FALSE
)

Arguments

planned_results_list

Output from planned comparison analysis containing:

Descriptives: Data frame with group_label, mean, sd, n
Contrasts: List of contrast results, each with comparison, t, df, p_value

dv_name Character. Descriptive name for DV.

reference_group Character. Label of the reference group being compared against.

comparison_groups Character vector. Labels of groups compared to reference.

hypothesis

List with hypothesis details:

direction: Expected direction: "reference_higher" or "reference_lower"
rh_text: Optional. Full RH statement.

alpha Significance level. Default 0.05.

include_effect_size Logical. Include effect sizes. Default FALSE.

Value

A character string with APA write-up.

Examples

library("psych350lab")

writeup <- apa_planned_comparisons_writeup(
  results,
  dv_name = "ratings of the importance of relevance",
  reference_group = "BWS",
  comparison_groups = c("CSA", "EWT"),
  hypothesis = list(
    direction = "reference_higher",
    rh_text = paste0("BWS evidence will be seen as more ",
      "important than CSA and EWT evidence")
  )
)