umxSummary.MxDataStatic: Summarize WLS / summary-statistic OpenMx::mxData objects

View source: R/umxGSEM.R

umxSummary.MxDataStaticR Documentation

Summarize WLS / summary-statistic OpenMx::mxData objects

Description

Explains modern OpenMx WLS data for users who have not seen type = "summary" and observedStats (cov, useWeight, asymCov). Works for MxDataStatic from OpenMx::mxData (including GSEM-style summary data).

Usage

## S3 method for class 'MxDataStatic'
umxSummary(
  model,
  digits = 3,
  report = c("markdown", "html"),
  matrices = c("cov", "useWeight", "asymCov"),
  ...
)

Arguments

model

An OpenMx::mxData object (MxDataStatic).

digits

Rounding for printed cells (default 3).

report

"markdown" (default) or "html".

matrices

Which observedStats blocks to print: any of c("cov", "useWeight", "asymCov", "means", "thresholds"). Default prints cov, useWeight, and asymCov when present. For LDSC-shaped content, extra args are passed through to umxSummary.list() (e.g. matrices = c("S","I","V")).

...

Passed to umxSummary.list() when LDSC-shaped observedStats is detected.

Details

If observedStats still holds LDSC/GSEM covstruc keys (S, V, ...) rather than modern WLS keys - e.g. mxData(type="summary", observedStats = Psych_LDSC, numObs = 2) - OpenMx stores those names as-is (it does not map S->cov or V->asymCov). This method detects that case, prints the LDSC content via umxSummary.list(), and notes how to build a working WLS mxData.

Value

Invisibly returns the input model.

See Also

umxSummary.list(), mxData, mxFitFunctionWLS, umxGSEM

Other GSEM: Anthro_LDSC, Psych_LDSC, plot.umx_GWAS(), umxGSEM(), umxGSEM_GWAS(), umxGSEM_dl_tutorial_files(), umxGSEM_label_ldsc(), umxGSEM_ldsc(), umxGSEM_munge(), umxGSEM_std(), umxGSEM_sumstats(), umxSummary.list()

Other Model Summary: umxSummary.MxLISRELModel(), umxSummary.list()

Examples

data(Psych_LDSC)
S = Psych_LDSC$S[1:3, 1:3]
V = Psych_LDSC$V[1:6, 1:6]
W = diag(1 / diag(V))
dimnames(W) = dimnames(V)
## Not run: 
# Needs modern OpenMx/GenomicMx (type = "summary" pure observedStats).
# CRAN OpenMx historically used type = "none" for this layout.
d = mxData(numObs = 1, type = "summary",
           observedStats = list(cov = S, useWeight = W, asymCov = V))
umxSummary(d)

## End(Not run)

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