Summary for Multiple Imputations Objects - Generic Function

DESCRIPTION:

Provides a summary of an mi object.

miSummaryAux is generic (see Methods); method functions can be written to handle specific classes of data. Classes which already have methods include: lm.

USAGE:

miSummary(object, ...) 
miSummaryAux(object1, object, ...) 
miSummaryAux.default(object1, object, ...) 

REQUIRED ARGUMENTS:

object
an mi object (containing multiple imputations).
object1
The first completed data set from object.

OPTIONAL ARGUMENTS:

...
optional arguments to be passed to methods for miSummary. For the default method these should not contain multiple imputations.

VALUE:

for the default method, an miList whose components are obtained by calling summary for each imputation.

DETAILS:

miSummary checks that all imputations have the same class, then calls generic function miSummaryAux which dispatches based on that class (the appropriate method to use in combining multiple imputations usually depends not on the class of object but rather on the class of the imputations of object). For example, if object is an miList object whose imputations are lm objects, then miSummaryAux dispatches to its lm method.

Methods for this function can be written to provide appropriate summaries which consolidate information across multiple imputations. Use getMethods("miSummaryAux") to see what methods have been defined.

If no method is found, then control passes to miSummaryAux.default , which just calls summary for each imputation, without combining information across imputations.

REFERENCES:

Schafer, J. L. (1997). Analysis of Incomplete Multivariate Data. Chapman & Hall, London.

our documentation

SEE ALSO:

, , .

EXAMPLES:

fit <- miEval(lm(chol14~., data = cholesterolImpExample)) 
miSummary(fit) 
miSummary(cholesterolImpExample[[3]]) 
summary(cholesterolImpExample[[3]])