% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils-data.R
\name{icc_check_design}
\alias{icc_check_design}
\title{Validate ICC Design Parameters}
\usage{
icc_check_design(
  same_raters,
  rater_effect = NULL,
  rating_type,
  agreement_type = NULL,
  k
)
}
\arguments{
\item{same_raters}{Logical. Required. Are all subjects measured by the same
group of raters? TRUE = yes, FALSE = no.}

\item{rater_effect}{Character. Optional (NULL). Rater effect type: "random" or "fixed".
Not required when \code{same_raters = FALSE}.}

\item{rating_type}{Character. Required. Type of rating used: "single" or "average".}

\item{agreement_type}{Character. Optional (NULL). Agreement type: "absolute" or "consistency".
Not required when \code{same_raters = FALSE}.}

\item{k}{Integer. Required. Number of raters (columns of the data), from \code{icc_preprocess_data}.}
}
\value{
A named list containing:
\describe{
  \item{is_valid}{Logical. Whether the design parameters are valid.}
  \item{error_msg}{Character or NULL. Error message for invalid parameters, NULL if valid.}
  \item{warning_msg}{Character or NULL. Warning message for non-recommended scenarios, NULL if none.}
  \item{tip_msg}{Character or NULL. Tip message for automatic mapping scenarios, NULL if none.}
}
}
\description{
Validates the legality of 4 core user-input design parameters, intercepts
invalid inputs in advance, and generates standardized warnings and tips
to avoid runtime errors during ICC calculation.
}
\references{
McGraw, K. O., & Wong, S. P. (1996). Forming inferences about some
intraclass correlation coefficients. Psychological Methods, 1(1), 30-46.
}
\keyword{internal}
