summary.mp_model {mlmpower}

Obtain the Parameter Summaries for A mp_model

Description

Provide the summarized parameter estimates for a mp_model, including the variance explained break downs.

Usage

## S3 method for class 'mp_model'
summary(object, ...)

Arguments

object

a mp_model

...

other arguments not used by this method.

Value

A mp_parameters object that contains the population parameters based on the model. If random correlations are used the average correlation is used to compute the parameters. If multiple ICC's are specified then a named base::list is returned containing the parameter value for each ICC value.

Examples

summary(
    outcome('Y')
    + within_predictor('X')
    + effect_size(icc = cross_sectional)
)