R/mimipo.R

In FarhadPishgar/MatchThem: Matching and Weighting Multiply Imputed Datasets

#' @title Multiply Imputed Pooled Outcome
#'
#' @docType class
#'
#' @aliases mimipo
#'
#' @rdname mimipo
#'
#' @name mimipo
#'
#' @description `mimipo` object contains data of multiply imputed pooled outcome. `mimipo` objects are generated by calls to `pool()`.
#'
#' @details `mimipo` objects has methods for the `print()` and `summary()` functions (please see \pkg{mice} package reference manual for details).
#'
#' @note The \pkg{MatchThem} package does not use the S4 class definitions and instead relies on the S3 list equivalents.
#'
#' @seealso [pool()]
#'
#' @author Farhad Pishgar
#'
#' @references Stef van Buuren and Karin Groothuis-Oudshoorn (2011). `mice`: Multivariate Imputation by Chained Equations in `R`. *Journal of Statistical Software*, 45(3): 1-67. \doi{10.18637/jss.v045.i03}
#'
#' @keywords classes

NULL