is_valid: Check if a Model is Properly Specified
In mlmpower: Power Analysis and Data Simulation for Multilevel Models
is_valid R Documentation
Check if a Model is Properly Specified
Description
This function is used to validate if a mp_model is correct.
If the model is incorrect an appopriate error message describing while will be supplied
Usage
is_valid(x)
Arguments
x
a mp_model
Value
Invisibly returns the original model.
Examples
# Create Model
model <- outcome('Y') + within_predictor('X')
# Throws error
tryCatch(
is_valid(model),
error = print
)
# Succeeds
is_valid(model + effect_size(icc = 0.1))
mlmpower documentation built on June 8, 2025, 11:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| is_valid | R Documentation |
Check if a Model is Properly Specified
Description
This function is used to validate if a mp_model is correct.
If the model is incorrect an appopriate error message describing while will be supplied
Usage
is_valid(x)
Arguments
x |
a |
Value
Invisibly returns the original model.
Examples
# Create Model
model <- outcome('Y') + within_predictor('X')
# Throws error
tryCatch(
is_valid(model),
error = print
)
# Succeeds
is_valid(model + effect_size(icc = 0.1))
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.