umx_set_optimization_options: Set options that affect optimization in OpenMx

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

Set options that affect optimization in OpenMx

Description

umx_set_optimization_options provides access to get and set options affecting optimization.

Usage

umx_set_optimization_options(
  opt = c("mvnRelEps", "mvnMaxPointsA", "Parallel diagnostics"),
  value = NULL,
  model = NULL,
  silent = FALSE
)

Arguments

opt	default returns current values of the options listed. Currently "mvnRelEps", "mvnMaxPointsA", and "Parallel diagnostics".
value	If not NULL, the value to set the opt to (can be a list of length(opt))
model	A model for which to set the optimizer. Default (NULL) sets the optimizer globally.
silent	If TRUE, no message will be printed.

Details

note: For mvnRelEps, values between .0001 to .01 are conventional. Smaller values slow optimization.

Value

• current values if no value set.

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_optimizer(), umx_set_plot_file_suffix(), umx_set_plot_format(), umx_set_plot_use_hrbrthemes(), umx_set_separator(), umx_set_silent(), umx_set_table_format()

Examples

# show current value for selected or all options
umx_set_optimization_options() # print the existing state(s)
umx_set_optimization_options("mvnRelEps") 
## Not run: 
umx_set_optimization_options("mvnRelEps", .01) # update globally
umx_set_optimization_options("Parallel diagnostics", value = "Yes") 

## End(Not run)

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