Skip to contents

Formats a fitted workflow's results as a compact table for a manuscript or a Quarto or R Markdown document. By default the table is written in APA style (7th ed.): readable column headings, two decimals, no leading zero on values that cannot exceed 1, p values to three decimals or < .001, and intervals as [LL, UL] under a heading that names their level.

Markdown output is generated directly, so no reporting package is required to use it. Nothing in the core analysis depends on one.

Usage

content_report(
  x,
  digits = 2,
  format = c("apa", "data.frame", "markdown"),
  include = c("all", "flagged"),
  caption = NULL
)

Arguments

x

A fitted contentvalid_workflow object.

digits

Decimal places for estimates. p values always get three, as APA requires.

format

"apa" (default), a table of formatted text in APA style; "markdown", the same table as Markdown lines; or "data.frame", the selected columns as rounded numbers under their names in results, for further computation. In the data frame, p values are rounded to three decimals, so one below .0005 becomes 0: report it as < .001, as the APA table does, or take the exact value from x$results.

include

"all" (default) or "flagged", which keeps only units whose status is not Supported.

caption

Optional caption line placed above a Markdown table.

Value

For "apa", a data frame of character columns that prints without row names; as.data.frame() drops its print class. An interval column is named after its estimate (V 95% CI, I-CVI 95% CI) and printed under the shared heading 95% CI. For "data.frame", a plain data frame with recommendation and status columns; for an essentiality fit it keeps the essential count ne and critical_ne, the count the exact test needed. For "markdown", a character vector of Markdown lines that prints as the table, carrying the analysis provenance as its "settings" attribute.

Markdown in a Quarto or R Markdown document

The Markdown lines become a table only when the document receives them as Markdown, so print them in a code chunk with the option results = "asis" (in Quarto, #| output: asis). In a chunk with the default option, they show as console output, pipes and all. The rule row aligns the first column, which names the units, and the other text columns left and numeric columns right, and the *Note.* paragraph follows the table after a blank line.

Changed in 0.9.0

The default is now format = "apa". Earlier versions returned the numeric table by default, with p values rounded to digits; use format = "data.frame" for that table, where p values now keep three decimals.

Changed in 1.0.0

Numbers in format = "data.frame" round half up, as the APA table does, so an exact tie such as 5 of 8 judges (.625) is 0.63 in both, where R's own rounding gave 0.62. The APA table prints under a header and carries its general note as the "note" attribute.

Reporting the decision rules

A results table alone is not a reproducible report. The thresholds that produced each status live in the fitted object's settings, and are attached to Markdown output as an attribute so they travel with the table. Report them alongside it: two analyses of identical data can disagree entirely because one used a different criterion.

See also

as.data.frame.contentvalid_workflow() for the untrimmed table, and compare_rounds() for reporting change across pretest rounds.

Examples

sorts <- read.csv(
  system.file("extdata", "sort_example.csv", package = "contentvalidR"),
  stringsAsFactors = FALSE
)
fit <- sort_validity(sorts)
content_report(fit)
#> <contentvalid_report> Results table in APA style
#> 
#>   Item  Target  Judges  Competitor  Psa      95% CI  Csv       p  Decision
#>   A1    A        18/20  B; C        .90  [.70, .97]  .85  < .001  Retain
#>   A2    A        15/20  B           .75  [.53, .89]  .60    .021  Retain
#>   B1    B        17/20  A           .85  [.64, .95]  .75    .001  Retain
#>   B2    B        13/20  A           .65  [.43, .82]  .40    .132  Review
#>   C1    C        18/20  A; B        .90  [.70, .97]  .85  < .001  Retain
#>   C2    C        14/20  B           .70  [.48, .85]  .50    .058  Review
#> 
#> Note. Psa = proportion of substantive agreement; CI = confidence interval;
#> Csv = coefficient of substantive validity. Judges = target assignments, out of
#> the judges who sorted the item. 95% CI = Wilson score confidence interval.
#> Retain = at least the number of target assignments the exact one-sided
#> binomial test needs at alpha = .05 with p0 = .50 (Howard & Melloy, 2016).
#> 
#> See content_report(fit, format = "markdown") for the table as Markdown, ready
#> for a manuscript.
# In a Quarto or R Markdown chunk with `results = "asis"`, these lines
# render as a table:
content_report(fit, format = "markdown", include = "flagged")
#> | Item | Target | Judges | Competitor | Psa | 95% CI | Csv | *p* | Decision |
#> | :--- | :--- | ---: | :--- | ---: | ---: | ---: | ---: | :--- |
#> | B2 | B | 13/20 | A | .65 | [.43, .82] | .40 | .132 | Review |
#> | C2 | C | 14/20 | B | .70 | [.48, .85] | .50 | .058 | Review |
#> 
#> *Note.* Psa = proportion of substantive agreement; CI = confidence interval;
#> Csv = coefficient of substantive validity. Judges = target assignments, out of
#> the judges who sorted the item. 95% CI = Wilson score confidence interval.
#> Retain = at least the number of target assignments the exact one-sided
#> binomial test needs at alpha = .05 with p0 = .50 (Howard & Melloy, 2016).