umxSummary.list: Summarize a Genomic SEM / LDSC covariance structure...

View source: R/umxGSEM.R

umxSummary.listR Documentation

Summarize a Genomic SEM / LDSC covariance structure (covstruc)

Description

Pretty-prints the trait list and the main LDSC/GSEM matrices (S, I, V, N, and scalar m) for objects like Psych_LDSC or the return value of umxGSEM_ldsc() (or OpenMx imxLDSC when present). Tables use markdown or HTML via umx_print.

Usage

## S3 method for class 'list'
umxSummary(
  model,
  digits = 3,
  report = c("markdown", "html"),
  matrices = c("S", "I", "V", "N"),
  traits = NULL,
  ...
)

Arguments

model

A covstruc list with at least matrices S (genetic cov) and V (sampling cov of vech(S)). Optional: I, N, m, S_Stand, V_Stand.

digits

Rounding for printed cells (default 3).

report

"markdown" (default) or "html" (browser-friendly kable).

matrices

Character vector of which components to show (default c("S", "I", "V", "N")). Unknown names are ignored. Scalar m is always mentioned in the header when present.

traits

Optional character vector of trait names to subset (default = NULL, which shows all).

...

Not used (S3 compatibility).

Value

Invisibly returns the input model (covstruc).

See Also

umxSummary.MxDataStatic(), Psych_LDSC, umxGSEM(), umx_print

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.MxDataStatic()

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

Examples

data(Psych_LDSC)
umxSummary(Psych_LDSC)
## Not run: 
umxSummary(Psych_LDSC, traits= c("MDD", "SCZ"), digits=5)
umxSummary(Psych_LDSC, report = "html")

## End(Not run)

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