umx_set_data_variance_check: umx_set_data_variance_check

In umx: Structural Equation Modeling and Twin Modeling in R

umx_set_data_variance_check

Description

Set default for data checking in models like umxACE umxGxE etc.

Usage

umx_set_data_variance_check(minVar = NULL, maxVarRatio = NULL, silent = FALSE)

Arguments

minVar	Set the threshold at which to warn user about variables with too-small variance. Else returns the current value of umx_minVar
maxVarRatio	Set the option for threshold at which to warn user variances differ too much. Else returns the current value of umx_maxVarRatio
silent	If TRUE, no message will be printed.

Value

- list of umx_minVar and umx_maxVarRatio settings

See Also

xmu_check_variance which uses these to check sanity in the variances of a data frame.

Other Get and set: umx, umx_get_alphas(), umx_get_checkpoint(), umx_get_options(), umx_set_auto_plot(), umx_set_auto_run(), umx_set_checkpoint(), umx_set_condensed_slots(), umx_set_cores(), umx_set_dollar_symbol(), umx_set_optimization_options(), umx_set_optimizer(), umx_set_plot_file_suffix(), umx_set_plot_format(), umx_set_separator(), umx_set_silent(), umx_set_table_format()

Examples

library(umx)
umx_set_data_variance_check() # print current state
old = umx_set_data_variance_check(silent = TRUE) # store existing value
umx_set_data_variance_check(minVar = .01)
umx_set_data_variance_check(maxVarRatio = 500)
umx_set_data_variance_check(minVar = old$minVar, maxVarRatio = old$maxVarRatio) # reinstate

umx documentation built on Nov. 5, 2025, 5:26 p.m.