% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/01_dataFormat.R
\name{dataFormat}
\alias{dataFormat}
\title{dataFormat}
\usage{
dataFormat(
  data,
  na = NULL,
  id = NULL,
  Z = NULL,
  w = NULL,
  response.type = NULL,
  CA = NULL
)
}
\arguments{
\item{data}{is a data matrix of the type matrix or data.frame.}

\item{na}{na argument specifies the numbers or characters to be treated as missing values.}

\item{id}{id indicates the column number containing the examinee ID.
If NULL (default), the first column is auto-detected as ID or response data.
If a column number is specified, that column is always used as the ID column.}

\item{Z}{Z is a missing indicator matrix of the type matrix or data.frame}

\item{w}{w is item weight vector}

\item{response.type}{Character string specifying the type of response data:
"binary" for dichotomous data,
"ordinal" for ordered polytomous data,
"rated" for polytomous data with correct answers,
"nominal" for unordered polytomous data.
If NULL (default), the type is automatically detected.}

\item{CA}{A numeric vector specifying the correct answers for rated polytomous data.
Required when response.type is "rated".}
}
\value{
\describe{
\item{U}{For binary response data. A matrix with rows representing the sample size and columns
representing the number of items, where elements are either 0 or 1. \eqn{u_{ij}=1} indicates
that student i correctly answered item j, while \eqn{u_{ij}=0} means that student i answered
item j incorrectly.}
\item{Q}{For polytomous response data. A matrix with rows representing the sample size and columns
representing the number of items, where elements are non-negative integers. When input data is
in factor format, the factor levels are converted to consecutive integers starting from 1.}
\item{ID}{The ID label given by the designated column or function.}
\item{ItemLabel}{The item names given by the provided column names or function.}
\item{Z}{Missing indicator matrix. \eqn{z_{ij}=1} indicates that item j is presented to Student i,
while \eqn{z_{ij}=0} indicates item j is NOT presented to Student i.
If the data contains NA values, -1 is assigned.}
\item{w}{Item weight vector}
\item{response.type}{Character string indicating the type of response data:
"binary", "ordinal", "rated", or "nominal"}
\item{CategoryLabel}{List containing the original factor labels when polytomous responses
are provided as factors. NULL if no factor data is present.}
\item{categories}{Numeric vector containing the number of response categories for each item.}
\item{CA}{For rated polytomous data, a numeric vector of correct answers. NULL for other types.}
}
}
\description{
This function serves the role of formatting the data prior to the analysis.
}
