subset.mp_model: Subset a 'mp_model' by Global ICC

subset.mp_modelR Documentation

Subset a mp_model by Global ICC

Description

Subsets a mp_model with multiple ICC values specified in effect_size into a model with only the single ICC value.

Usage

## S3 method for class 'mp_model'
subset(x, icc, ...)

Arguments

x

a mp_model object

icc

a single numeric value to subset out of x

...

other arguments not used by this method.

Value

A new mp_model with only the subset ICC

Examples

# Create Model
model <- (
    outcome('Y')
    + within_predictor('X')
    + effect_size(icc = cross_sectional)
)
# Obtain Model with only 0.15 ICC
model |> subset(icc = 0.15)

mlmpower documentation built on June 8, 2025, 11:07 a.m.