summary_table: Get A Summary Table From A cs_analysis Object

In clinicalsignificance: A Toolbox for Clinical Significance Analyses in Intervention Studies

Get A Summary Table From A cs_analysis Object

Description

Retrieve the summary table in a tidy tibble format. This is especially useful to plot the results or conduct sensitivity analyses.

Usage

cs_get_summary(x, ...)

## Default S3 method:
cs_get_summary(x, which = c("individual", "group"), ...)

## S3 method for class 'cs_anchor_group_within'
cs_get_summary(x, ...)

## S3 method for class 'cs_anchor_group_between'
cs_get_summary(x, ...)

Arguments

x	An object of class cs_analysis
...	Additional arguments passed to the respective method
which	Which level of summary table to return. This is only necessary for method "HA" since two summary tables are reported. Available are individual, the default group, group level results according to Hageman & Arrindell (1999)

Value

A tibble with clinical significance categories

References

• Hageman, W. J., & Arrindell, W. A. (1999). Establishing clinically significant change: increment of precision and the distinction between individual and group level analysis. Behaviour Research and Therapy, 37(12), 1169–1193. https://doi.org/10.1016/S0005-7967(99)00032-7

See Also

Extractor functions cs_get_augmented_data(), cs_get_data(), cs_get_model(), cs_get_n(), cs_get_reliability()

Examples

anchor_results <- claus_2020 |>
  cs_anchor(
    id,
    time,
    bdi,
    pre = 1,
    post = 4,
    mid_improvement = 8
  )

cs_get_summary(anchor_results)


# Get summary table for a group level analysis
anchor_results_grouped <- claus_2020 |>
  cs_anchor(
    id,
    time,
    bdi,
    pre = 1,
    post = 4,
    mid_improvement = 8,
    target = "group"
  )

cs_get_summary(anchor_results_grouped)


# Get group-wise summary table for the Hageman & Arrindell method
combined_results <- claus_2020 |>
  cs_combined(
    id,
    time,
    bdi,
    pre = 1,
    post = 4,
    m_functional = 8,
    sd_functional = 8,
    reliability = 0.80,
    rci_method = "HA"
  )

cs_get_summary(combined_results)
cs_get_summary(combined_results, which = "group")

clinicalsignificance documentation built on April 4, 2025, 12:19 a.m.