Skip to contents

APA-style content validity table

Source: R/apa_table.R
apa_table.Rd

Generates a publication-ready content validity table following APA conventions, suitable for inclusion in journal manuscripts, theses, and technical reports. Returns a clean data frame by default, with optional rendering to markdown, HTML, or LaTeX via knitr::kable().

Usage

apa_table(x, ...)

# S3 method for class 'content_validity'
apa_table(
  x,
  format = c("data.frame", "markdown", "html", "latex", "pipe"),
  digits = 2,
  interpretation = TRUE,
  interpretation_index = c("mod_kappa", "gwet_ac1", "gwet_ac2", "icvi"),
  caption = NULL,
  ...
)

Arguments

x

An object to format. Currently supports objects of class "content_validity" returned by content_validity().

...

Further arguments passed to methods.

format

Output format. One of "data.frame" (default), "markdown", "html", "latex", or "pipe". All formats other than "data.frame" require the knitr package.

digits

Integer. Number of decimal places for numeric values. Default 2 (APA convention for proportions and correlations).

interpretation

Logical. Whether to include an interpretation column. Default TRUE. The cutoffs depend on interpretation_index.

interpretation_index

Character. Which index drives the interpretation column. One of "mod_kappa" (default; Cicchetti & Sparrow, 1981; Polit, Beck, & Owen, 2007), "gwet_ac1" (Altman, 1991), "gwet_ac2" (Altman, 1991), or "icvi" (Polit & Beck, 2006). The resulting column is named accordingly (e.g., "Kappa Interpretation", "AC1 Interpretation") so that the labels are not confused with the other columns in the table.

caption

Optional character string. The caption to use when format is not "data.frame". If NULL (default), a standard caption is generated that reports the scale-level indices.

Value

A data frame (when format = "data.frame") or a character string suitable for inclusion in an R Markdown document (other formats).

Details

Item-level interpretation labels follow the modified-kappa cutoffs of Cicchetti and Sparrow (1981), as adopted by Polit, Beck, and Owen (2007):

  • Excellent: kappa* > 0.74

  • Good: kappa* 0.60 to 0.74

  • Fair: kappa* 0.40 to 0.59

  • Poor: kappa* < 0.40

Scale-level indices are reported in the caption rather than the table body, matching the typical layout used in nursing, education, and health-sciences journals.

References

Cicchetti, D. V., & Sparrow, S. A. (1981). Developing criteria for establishing interrater reliability of specific items: Applications to assessment of adaptive behavior. American Journal of Mental Deficiency, 86(2), 127-137.

Polit, D. F., Beck, C. T., & Owen, S. V. (2007). Is the CVI an acceptable indicator of content validity? Appraisal and recommendations. Research in Nursing & Health, 30(4), 459-467. doi:10.1002/nur.20199

Examples

data(cvi_example)
result <- content_validity(cvi_example)

# Default: a clean data frame
apa_table(result)
#>      Item I-CVI Modified Kappa Kappa Interpretation Aiken's V Gwet's AC1
#> 1   item1  1.00           1.00            Excellent      1.00       1.00
#> 2   item2  1.00           1.00            Excellent      0.89       1.00
#> 3   item3  1.00           1.00            Excellent      0.78       1.00
#> 4   item4  0.83           0.82            Excellent      0.67       0.54
#> 5   item5  0.67           0.56                 Fair      0.61       0.04
#> 6   item6  1.00           1.00            Excellent      0.94       1.00
#> 7   item7  0.83           0.82            Excellent      0.67       0.54
#> 8   item8  1.00           1.00            Excellent      0.94       1.00
#> 9   item9  0.50           0.27                 Poor      0.50      -0.20
#> 10 item10  1.00           1.00            Excellent      0.94       1.00
#>    Gwet's AC2
#> 1        1.00
#> 2        0.90
#> 3        0.90
#> 4        0.83
#> 5        0.69
#> 6        0.95
#> 7        0.83
#> 8        0.95
#> 9        0.87
#> 10       0.95

# Markdown for R Markdown documents
if (requireNamespace("knitr", quietly = TRUE)) {
  apa_table(result, format = "markdown")
}
#> 
#> 
#> Table: Content validity indices (N = 6 experts, 10 items; S-CVI/Ave = 0.88, S-CVI/UA = 0.60).
#> 
#> |Item   | I-CVI| Modified Kappa|Kappa Interpretation | Aiken's V| Gwet's AC1| Gwet's AC2|
#> |:------|-----:|--------------:|:--------------------|---------:|----------:|----------:|
#> |item1  |  1.00|           1.00|Excellent            |      1.00|       1.00|       1.00|
#> |item2  |  1.00|           1.00|Excellent            |      0.89|       1.00|       0.90|
#> |item3  |  1.00|           1.00|Excellent            |      0.78|       1.00|       0.90|
#> |item4  |  0.83|           0.82|Excellent            |      0.67|       0.54|       0.83|
#> |item5  |  0.67|           0.56|Fair                 |      0.61|       0.04|       0.69|
#> |item6  |  1.00|           1.00|Excellent            |      0.94|       1.00|       0.95|
#> |item7  |  0.83|           0.82|Excellent            |      0.67|       0.54|       0.83|
#> |item8  |  1.00|           1.00|Excellent            |      0.94|       1.00|       0.95|
#> |item9  |  0.50|           0.27|Poor                 |      0.50|      -0.20|       0.87|
#> |item10 |  1.00|           1.00|Excellent            |      0.94|       1.00|       0.95|