% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/datasets.R
\name{mfrmr_example_data}
\alias{mfrmr_example_data}
\alias{mfrmr_example_core}
\alias{mfrmr_example_bias}
\title{Purpose-built example datasets for package help pages}
\format{
A data.frame with 6 columns:
\describe{
\item{Study}{Example dataset label (\code{"ExampleCore"} or \code{"ExampleBias"}).}
\item{Person}{Person/respondent identifier.}
\item{Rater}{Rater identifier.}
\item{Criterion}{Criterion facet label.}
\item{Score}{Observed category score on a four-category scale (\code{1}--\code{4}).}
\item{Group}{Balanced grouping variable used in DFF/DIF examples (\code{"A"} / \code{"B"}).}
}
}
\source{
Synthetic documentation data generated from rating-scale Rasch facet
designs with fixed seeds in \code{data-raw/make-example-data.R}.
}
\description{
Compact synthetic many-facet datasets designed for documentation examples.
Both datasets are large enough to avoid tiny-sample toy behavior while
remaining fast in \verb{R CMD check} examples.
}
\details{
Available data objects:
\itemize{
\item \code{mfrmr_example_core}
\item \code{mfrmr_example_bias}
}

\code{mfrmr_example_core} is generated from a single latent trait plus rater and
criterion main effects, making it suitable for general fitting, plotting, and
reporting examples.

\code{mfrmr_example_bias} starts from the same basic design but adds:
\itemize{
\item a known \verb{Group x Criterion} effect (\verb{Group B} is advantaged on \code{Language})
\item a known \verb{Rater x Criterion} interaction (\verb{R04 x Accuracy})
}

This lets differential-functioning and bias-analysis help pages demonstrate non-null findings.
}
\section{Data dimensions}{

\tabular{lrrrrr}{
\strong{Dataset} \tab \strong{Rows} \tab \strong{Persons} \tab \strong{Raters} \tab \strong{Criteria} \tab \strong{Groups} \cr
example_core \tab 768 \tab 48 \tab 4 \tab 4 \tab 2 \cr
example_bias \tab 384 \tab 48 \tab 4 \tab 4 \tab 2
}
}

\section{Suggested usage}{

\itemize{
\item Use \code{mfrmr_example_core} for fitting, diagnostics, design-weighted precision curves,
and generic plots/reports.
\item Use \code{mfrmr_example_bias} for \code{\link[=analyze_dff]{analyze_dff()}}, \code{\link[=analyze_dif]{analyze_dif()}}, \code{\link[=dif_interaction_table]{dif_interaction_table()}},
\code{\link[=plot_dif_heatmap]{plot_dif_heatmap()}}, and \code{\link[=estimate_bias]{estimate_bias()}}.
}

Both objects can be loaded either with \code{\link[=load_mfrmr_data]{load_mfrmr_data()}} or directly via
\code{data("mfrmr_example_core", package = "mfrmr")} /
\code{data("mfrmr_example_bias", package = "mfrmr")}.
}

\examples{
data("mfrmr_example_core", package = "mfrmr")
table(mfrmr_example_core$Score)
table(mfrmr_example_core$Group)
}
