R/wimids.R

In MatchIt.mice: Matching Multiply Imputed Datasets

#' @title Weighted Multiply Imputed Dataset
#'
#' @docType class
#'
#' @aliases wimids
#'
#' @rdname wimids
#'
#' @name wimids
#'
#' @description The \code{wimids} object contains data of weighted multiply imputed datasets. The \code{wimids} object is generated by the \code{weightitmice()} function.
#'
#' @details The \code{wimids} objects has methods for the \code{print()}, \code{summary()}, and \code{plot()} functions.
#'
#' @note The \pkg{MatchIt.mice} package does not use the S4 class definitions, and instead relies on the S3 list equivalents.
#'
#' @seealso \code{\link[=weightitmice]{weightitmice}}
#'
#' @author Farhad Pishgar
#'
#' @references Stef van Buuren and Karin Groothuis-Oudshoorn (2011). \code{mice}: Multivariate Imputation by Chained Equations in \code{R}. \emph{Journal of Statistical Software}, 45(3): 1-67. \url{https://www.jstatsoft.org/v45/i03/}
#'
#' @keywords classes

NULL