% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/apa_table.R
\name{apa_table}
\alias{apa_table}
\alias{apa_table.content_validity}
\title{APA-style content validity table}
\usage{
apa_table(x, ...)

\method{apa_table}{content_validity}(
  x,
  format = c("data.frame", "markdown", "html", "latex", "pipe"),
  digits = 2,
  interpretation = TRUE,
  caption = NULL,
  ...
)
}
\arguments{
\item{x}{An object to format. Currently supports objects of class
\code{"content_validity"} returned by \code{\link[=content_validity]{content_validity()}}.}

\item{...}{Further arguments passed to methods.}

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

\item{digits}{Integer. Number of decimal places for numeric values.
Default 2 (APA convention for proportions and correlations).}

\item{interpretation}{Logical. Whether to include an Interpretation
column based on modified-kappa cutoffs (Cicchetti & Sparrow, 1981).
Default \code{TRUE}.}

\item{caption}{Optional character string. The caption to use when format
is not \code{"data.frame"}. If \code{NULL} (default), a standard caption is
generated that reports the scale-level indices.}
}
\value{
A data frame (when \code{format = "data.frame"}) or a character
string suitable for inclusion in an R Markdown document (other formats).
}
\description{
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 \code{\link[knitr:kable]{knitr::kable()}}.
}
\details{
Item-level interpretation labels follow the modified-kappa cutoffs of
Cicchetti and Sparrow (1981), as adopted by Polit, Beck, and Owen (2007):
\itemize{
\item Excellent: kappa* > 0.74
\item Good: kappa* 0.60 to 0.74
\item Fair: kappa* 0.40 to 0.59
\item 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.
}
\examples{
data(cvi_example)
result <- content_validity(cvi_example)

# Default: a clean data frame
apa_table(result)

# Markdown for R Markdown documents
if (requireNamespace("knitr", quietly = TRUE)) {
  apa_table(result, format = "markdown")
}

}
\references{
Cicchetti, D. V., & Sparrow, S. A. (1981). Developing criteria for
establishing interrater reliability of specific items: Applications to
assessment of adaptive behavior. \emph{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.
\emph{Research in Nursing & Health}, 30(4), 459-467.
\doi{10.1002/nur.20199}
}
