Learn R Programming

gerbil (version 0.1.9)

summary.cor_gerbil: Summarises a gerbil object. Printed output includes a variable-by-variable summary of variable types and missingness rates. The implemented predictor matrix is also provided.

Description

Summarises a gerbil object. Printed output includes a variable-by-variable summary of variable types and missingness rates. The implemented predictor matrix is also provided.

Usage

# S3 method for cor_gerbil
summary(object, ...)

Value

The functions print.cor_gerbil and summary.cor_gerbil display information about the cor_gerbil object. The output displayed includes: 1) the average absolute difference in correlation between observed and imputed cases across all relevant variable pairs, 2) the average value of the test statistic based on Fisher's z across all variable pairs, 3) the largest test statistic observed across any variable pair, and 4) the portion of p-values for the test based on Fisher's z that are less than 0.05.

Arguments

object

An object of cor_gerbil class

...

additional parameters to be passed down to inner functions.