install.OpenMx: Install OpenMx (GenomicMx binary build)

In umx: Structural Equation Modeling and Twin Modeling in R

Install OpenMx (GenomicMx binary build)

Description

Install stock CRAN OpenMx, or the GenomicMx OpenMx build used by umx for modern WLS/GSEM (Jacobians, type = "summary" WLS data, multi-group stack). The GenomicMx build replaces whatever OpenMx is in the target library (same idea as the old NPSOL binary installs).

Public install path (everyone): pre-built OpenMx binaries are published on the umx GitHub Release tag genomicmx (⁠https://github.com/tbates/umx/releases/tag/genomicmx⁠). Call install.OpenMx("GenomicMx") (the default). That is the supported way to get the GenomicMx engine while the OpenMx source tree lives privately on GitHub. Binaries are CRAN flavour (no NPSOL) and are built for R release on Linux x86_64, Windows x86_64, and macOS arm64 (Phase 1).

Options for loc:

1. "GenomicMx" (default): download the platform binary for this OS/arch/R from the genomicmx Release tag when available.

2. "CRAN": install stock OpenMx from CRAN (enough for many twin/RAM models, not the full GenomicMx WLS stack).

3. "open release page": open the umx GenomicMx Release tag in a browser so you can pick a binary by hand.

GenomicMx binaries are linked against oneTBB and declare current-CRAN Imports floors (including ⁠RcppParallel >= 6.2.0⁠ and Matrix >= 1.7-6). install.OpenMx("GenomicMx") (and a custom url binary) upgrades those packages first. A repos = NULL binary install does not upgrade Imports, so R's recommended Matrix (often one patch behind CRAN) used to fail with ⁠package 'Matrix' 1.7-5 was found, but >= 1.7.6 is required⁠. After the OpenMx files are in place, this function tries loadNamespace("OpenMx") when OpenMx is not already loaded. If OpenMx is already loaded, restart R to pick up the new .so / .dll.

Source installs from a private GitHub fork are not offered here (they cannot work for general users). Maintainers building OpenMx locally should use mx_make() on their source tree.

Usage

install.OpenMx(
  loc = c("GenomicMx", "open GenomicMx release page", "CRAN"),
  url = NULL,
  lib,
  repos = getOption("repos")
)

umx_update_OpenMx(
  loc = c("GenomicMx", "open GenomicMx release page", "CRAN"),
  url = NULL,
  lib,
  repos = getOption("repos")
)

Arguments

loc	Which build to get (default "GenomicMx").
url	Custom URL or local path to an OpenMx binary package. On Mac, "Finder" uses the package selected in the Finder; "" opens a file chooser.
lib	Where to install the package (passed to install.packages()).
repos	CRAN repository (for loc = "CRAN").

Value

None (called for side effects).

References

https://github.com/tbates/umx, https://github.com/tbates/umx/releases/tag/genomicmx

See Also

umxVersion(), xmu_openmx_engine_status(), mx_make()

Other Miscellaneous Utility Functions: libs(), qm(), umx, umxLav2RAM(), umxModelNames(), umxRAM2Lav(), umxVersion(), umx_ICA_report(), umx_array_shift(), umx_data(), umx_find_object(), umx_lower.tri(), umx_msg(), umx_open_CRAN_page(), umx_pad(), umx_print(), umx_tail(), umx_wide2long(), umx_wide4lmer()

Examples

## Not run: 
install.OpenMx("GenomicMx")           # GenomicMx OpenMx binary from umx Releases (default)
install.OpenMx("open release page") # browse releases and install a file yourself
install.OpenMx("CRAN")                # stock CRAN OpenMx only

## End(Not run)

umx documentation built on Oct. 11, 2026, 5:07 p.m.