parameters {mlmpower}

Obtain mp_parameters from objects

Description

A generic function to obtain mp_parameters from defined models and data sets.

Usage

parameters(object)

## S3 method for class 'mp_model'
parameters(object)

## S3 method for class 'mp_data'
parameters(object)

## S3 method for class 'mp_power'
parameters(object)

Arguments

object

an object which the mp_parameters are desired.

Details

Currently object can be:

• mp_model

• mp_data

• mp_power

If using on a mp_model and the model has random correlations then the average is used.

Value

A mp_parameters object

Examples

# Create Model
model <- (
    outcome('Y')
    + within_predictor('X')
    + effect_size(icc = 0.1)
)

# Create data set and obtain population parameters
model |> parameters()
# Set seed
set.seed(198723)
# Create data set and obtain population parameters
model |> generate(5, 50) |> parameters()
# Set seed
set.seed(198723)
# Create data set and obtain population parameters
model |> power_analysis(50, 5, 50) |> parameters()