umx_set_silent: Turn off most console and summary output from umx

In tbates/umx: Structural Equation Modeling and Twin Modeling in R

Turn off most console and summary output from umx

Description

Running multiple analyses or simulations, it can be handy to turn off the automatic summary, graphing, and printing that umx does to help interactive sessions. umx_set_silent does this. Summary and graph output, as well as progress and durable console output will be suppressed.

Usage

umx_set_silent(value = NA, silent = FALSE)

Arguments

value	Boolean stating if umx Models should run silently (TRUE).
silent	If TRUE, this function itself will just return the state of the option, with no user message.

Details

Not every function knows about silent, but most, like umxRAM() etc do.

Under the hood, umx_set_silent sets options("umx_silent"). This can be set to either TRUE or FALSE. If TRUE, then the progress messages from model runs are suppressed. Useful for power simulations etc.

Value

• Current silent value

References

• https://tbates.github.io, https://github.com/tbates/umx

See Also

Other Get and set: umx, 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_data_variance_check(), umx_set_dollar_symbol(), umx_set_optimization_options(), umx_set_optimizer(), umx_set_plot_file_suffix(), umx_set_plot_format(), umx_set_plot_use_hrbrthemes(), umx_set_separator(), umx_set_table_format()

Examples

library(umx)
old = umx_set_silent() # print & store existing value
umx_set_silent(FALSE, silent = TRUE) # set to FALSE
umx_set_silent(old)   # reinstate
umx_set_silent() # print existing value

tbates/umx documentation built on Dec. 14, 2024, 11:28 a.m.