Learn R Programming

⚠️There's a newer version (4.20.0) of this package.Take me there.

umx

umx is a structural equation modelling package designed to make SEM easier to build, modify, and report.

It includes high-level functions for complex models such as multi-group twin models, as well as for graphical model output.

Grab it from CRAN with

install.packages("umx")
library(umx)
?umx

The best way to learn what is on offer is to use the help ('?umx' works) and the online tutorial: tbates.github.io

umx stands for "user" OpenMx functions. umx contains over 100 functions which build on OpenMx, and are designed to automate activities such as labelling, setting start values etc., and also provides umxRAM and umxPath functions that make Structural Equation Modeling in R straightforward.

Some highlights include:

  1. Building Path Models
    • umxRAM() # mxModel with smart data = parameter, no need to specify type = "RAM", + auto-discovery of manifests and latents from the paths you write
    • umxPath() # mxPath on steroids: one-word settings to set var , mean cov, fixedAt 'v.m.' = and more. Great time-saver!
  2. Reporting output
    • umxSummary(model) # A model fit designed for journal reporting (Χ², p, CFI, TLI, & RMSEA). Optionally show the path loadings
    • plot(model, std=T, digits = 3, file = "name") # Graphical, editable output of model in your browser!
  3. Modify models
    • umxModify() *# Modify and run a model. You can add objects, drop or add paths, including by regular-expression label matching), re-name the model, re-run, and even return the comparison. All in 1 line *
    • umxGetParameters(model, regex = "as_r_2c_[0-9]", free = T) # A powerful assistant to get labels from a model. like omxGetParameters but uses regular expressions.
  4. Twin modeling!
    • umxACE() # Twin ACE modeling with aplomb paths are labeled! Works with plot() and umxSummary!
    • umxCP(), umxIP(), umxGxE(), umxCP()
  5. Easy-to-remember options
    • umx_set_cores()
    • umx_set_optimizer()
  6. Many more miscellaneous Helpers and smart expert helpers e.g.
    • umx_time(model) # Report the time taken by a model in a compact programable format
    • umxStart() # Add plausible start values to RAM or matrix models, or matrices: very helpful
    • umxLabel() # Add systematic labels to paths ("var1_to_var2") and matrix cells ("a_r1c1"). This is great for setting, equating and dropping paths by label!
    • umxHcor(data, use = "pairwise.complete.obs") # Compute appropriate pair-wise correlations for mixed data types.

Dozens more (?umx to see them all). Check out the "family links" in any help file also!

Feel free to use, or improve, or make request via Github. Tell your friends! Publish more good science :-)

Bleeding-edge development version here:

install.packages("devtools")
library("devtools")
install_github("tbates/umx")
library("umx")
?umx

Copy Link

Version

Install

install.packages('umx')

Monthly Downloads

1,531

Version

1.5.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Timothy C Bates

Last Published

January 13th, 2017

Functions in umx (1.5.0)

confint.MxModel

Get confidence intervals from an MxModel
extractAIC.MxModel

extractAIC from MxModel
plot.MxModel

Create a graphical figure from an MxModel
install.OpenMx

install.OpenMx
ex9_6

A multilevel dataset.
qm

qm
loadings

loadings Generic loadings function to extract factor loadings from exploratory or confirmatory factor analyses.
loadings.MxModel

loadings.MxModel
logLik.MxModel

logLik.MxModel
dl_from_dropbox

dl_from_dropbox
umx_apply

umx_apply
umx_APA_pval

umx_APA_pval
RMSEA.MxModel

RMSEA function for MxModels
umx_aggregate

umx_aggregate
RMSEA

Generic RMSEA function
reliability

reliability
residuals.MxModel

Get residuals from an MxModel
RMSEA.summary.mxmodel

RMSEA function for MxModels
umx_APA_model_CI

umx_APA_model_CI
umx_add_variances

umx_add_variances
umx_fun_mean_sd

umx_fun
umx_fix_latents

umx_fix_latents
umx_cov2raw

Turn a cov matrix into raw data with umx_cov2raw
umx_cov_diag

umx_cov_diag
umx_has_been_run

umx_has_been_run
umx_has_CIs

umx_has_CIs
umx_is_cov

umx_is_cov
umx_fix_first_loadings

umx_fix_first_loadings
umx_find_object

umx_find_object
umx_is_endogenous

umx_is_endogenous
umx_make

umx_make umx using devtools
umx_means

umx_means
umx_set_plot_format

umx_set_plot_format
umx_read_lower

Read lower-triangle of data matrix from console or file
umx_check_parallel

umx_check_parallel
umx_rename_file

umx_rename_file
umx_set_optimizer

umx_set_optimizer
umx_is_MxMatrix

umx_is_MxMatrix
umx_check

umx_check
umx_is_MxModel

umx_is_MxModel
umx_open

umx_open
umx_standardize_RAM

umx_standardize_RAM
umx_string_to_algebra

umx_string_to_algebra
umx_object_as_str

umx_object_as_str
umxACEcov

umxACEcov: Build and run a Cholesky with covariates in the covariance
umxACESexLim

umxACESexLim: Build and run a sex-limitaiton twin model (not working yet)
umx_pb_note

umx_pb_note
umxCI

umxCI
umx_print

umx_print
umxCompare

umxCompare
umx_swap_a_block

umx_swap_a_block
umx_round

umx_round
umx_scale_wide_twin_data

umx_scale_wide_twin_data
umx_trim

umx_trim
umxCov2cor

umxCov2cor
umx-deprecated

Deprecated. May already stop() code and ask to be updated. May be dropped entirely in future.
umx_time

umx_time
umx_is_MxData

umx_is_ordered
umx_is_exogenous

umx_is_exogenous
umx_set_condensed_slots

umx_set_condensed_slots
umx_set_cores

umx_set_cores
umx_standardize_CP

umx_standardize_CP
umx

Helper Functions for Structural Equation Modelling in OpenMx
umx_standardize_IP

umx_standardize_IP
umxACE

umxACE: Build and run a Cholesky (uni- or multi-variate)
umxDiagnose

mxDiagnostic
umxCP

umxCP: Build and run a Common pathway twin model
umxPlotACE

umxPlotACE
umxCovData

umxCovData
umxPlotACEcov

umxPlotACEcov
umxRun

umxRun: Run an mxModel
umxSetParameters

umxSetParameters: Set parameters in an mxModel
umxSummaryGxE

umxSummaryGxE
umxSummaryCP

umxSummaryCP
umx_cor

umx_cor
umx_cont_2_quantiles

umx_cont_2_quantiles
xmuLabel_Matrix

xmuLabel_Matrix (not a user function)
umx_get_checkpoint

umx_get_checkpoint
umx_get_bracket_addresses

get mat[r,c] style cell address from an mxMatrix
umx_get_options

umx_get_options
umx_make_fake_data

umx_make_fake_data
umx_grep

umx_grep
umx_make_MR_data

Simulate Mendelian Randomization data
umx_check_model

umx_check_model
umx_as_numeric

umx_as_numeric
umx_drop_ok

umx_drop_ok
umx_default_option

umx_default_option
umx_has_means

umx_has_means
umx_has_square_brackets

umx_has_square_brackets
umxHetCor

umxHetCor
umxMatrix

umxMatrix: labeled mxMatrix, with name in the first place
umxLatent

umxLatent: Helper to ease making formative and reflective latent variables
umxIP

umxIP: Build and run an Independent pathway twin model
umxTwoStage

umxTwoStage
umxRAM

umxRAM: Easy-to-use RAM model maker.
umxPlotIP

umxPlotIP
umx_lower2full

umx_lower2full
umx_make_bin_cont_pair_data

umx_make_bin_cont_pair_data
umx_make_TwinData

umx_make_TwinData: Simulate twin data with control over A, C, E, and moderation
umx_make_sql_from_excel

umx_make_sql_from_excel
umx_scale

umx_scale
umx_reorder

umx_reorder
umx_rename

umx_rename
umx_move_file

umx_move_file
umx_merge_CIs

umx_merge_CIs
umx_rot

umx_rot
umx_residualize

umx_residualize
umx_standardize_ACE

umx_standardize_ACE
umx_standardize_ACEcov

umx_standardize_ACEcov
umxEquate

umxEquate: Equate two or more paths
umxMI

umxMI
umxExpMeans

umxExpMean
umxExpCov

Get the expected vcov matrix
umxModify

umxModify: Add, set, or drop model paths by label.
xmuMakeThresholdsMatrices

xmuMakeThresholdsMatrices (not a user function)
xmuMakeTwoHeadedPathsFromPathList

xmuMakeTwoHeadedPathsFromPathList
umx_set_auto_plot

umx_set_auto_plot
umxCF_SexLim

umxCF_SexLim
umxCI_boot

umxCI_boot
umxFactor

umxFactor
umxLabel

umxLabel: Add labels to a RAM model, matrix, or path
umxFitIndices

umxFitIndices
umxJiggle

umxJiggle
umxPlotCP

umxPlotCP
umxPlotGxE

umxPlotGxE
umxValues

umxValues: Set values in RAM model, matrix, or path
xmuHasSquareBrackets

xmuHasSquareBrackets
us_skinfold_data

Anthropometric data on twins
xmuLabel_MATRIX_Model

xmuLabel_MATRIX_Model (not a user function)
xmuLabel_RAM_Model

xmuLabel_RAM_Model (not a user function)
xmuMinLevels

xmuMinLevels
umxUnexplainedCausalNexus

umxUnexplainedCausalNexus
xmuPropagateLabels

xmuPropagateLabels (not a user function)
xmu_dot_make_paths

xmu_dot_make_paths (not for end users)
xmu_check_levels_identical

xmu_check_levels_identical
umx_check_names

umx_check_names
umx_explode

umx_explode - like the php function `explode`
umx_check_OS

umx_check_OS
umx_get_cores

umx_get_cores
umx_explode_twin_names

umx_explode_twin_names
umx_get_optimizer

umx_get_optimizer
umx_is_ordered

umx_is_ordered
umx_is_RAM

umx_is_RAM
umx_msg

umx_msg
umx_pad

Pad an Object with NAs
umx_names

umx_names
umx_paste_names

umx_paste_names
umx_set_auto_run

umx_set_auto_run
umx_show

umx_show
umx_set_checkpoint

umx_set_checkpoint
umxAdd1

umxAdd1
umx_set_table_format

umx_set_table_format
umxAPA

umxAPA
umxDrop1

umxDrop1: Unfinished function to mimic drop1 in OpenMx
umxGxE_window

umxGxE_window
umxEval

umxEval
umxGxE

umxGxE: Implements ACE models with moderation of paths, e.g. by SES.
umxPadAndPruneForDefVars

umxPadAndPruneForDefVars
umxPath

umxPath: Easier (but powerful) specification of RAM paths.
umxFixAll

umxFixAll: Fix all free parameters
umxEFA

umxEFA
umxRAM2Ordinal

umxRAM2Ordinal
umxGetParameters

umxGetParameters: Get parameters from a model
umxSummary

umxSummary.default
umxSummary.MxModel

umxSummary.MxModel
umxSummaryACE

umxSummaryACE
umxSummaryIP

umxSummaryIP
umxSummaryACEcov

umxSummaryACEcov
umxReduce

umxReduce
xmu_start_value_list

Make start values
xmu_dot_make_residuals

xmu_dot_make_residuals (not for end users)
umxThresholdMatrix

umxThresholdMatrix: Helper makes a complete threshold matrix needed in ordinal models.
xmuMakeDeviationThresholdsMatrices

Make deviation threshold matrics
xmuMI

xmuMI
xmuMaxLevels

xmuMaxLevels
xmuMakeOneHeadedPathsFromPathList

xmuMakeOneHeadedPathsFromPathList