summary.mp_power {mlmpower}

Summarizes a mp_power

Description

Summarizes a mp_power in a human readable format. This is a simple wrapper for print.mp_power.

Usage

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

Arguments

object

a mp_power.

...

other arguments not used by this method.

Value

Invisibly returns the original variable.

Examples

# Create Model
model <- (
    outcome('Y')
    + within_predictor('X')
    + effect_size(icc = 0.1)
)
# Set seed
set.seed(19723)
# Create data set and analyze
# Note: Generally Use more than 50 replications
model |> power_analysis(50, 5, 50) -> powersim
# Summarizes results
summary(powersim)