umx (version 4.20.0)

umxSummarySimplex: Shows a compact, publication-style, summary of a Simplex model.

Description

Summarize a fitted Simplex model returned by umxSimplex(). Can control digits, report comparison model fits, optionally show the Rg (genetic and environmental correlations), and show confidence intervals. the report parameter allows drawing the tables to a web browser where they may readily be copied into non-markdown programs like Word.

Usage

umxSummarySimplex(
  model,
  digits = 2,
  file = getOption("umx_auto_plot"),
  comparison = NULL,
  std = TRUE,
  showRg = FALSE,
  CIs = TRUE,
  report = c("markdown", "html"),
  returnStd = FALSE,
  extended = FALSE,
  zero.print = ".",
  show = c("std", "raw"),
  ...
)

Value

• optional mxModel()

Arguments

model

an mxModel() to summarize

digits

round to how many digits (default = 2)

file

The name of the dot file to write: "name" = use the name of the model. Defaults to NA = no plot.

comparison

you can run mxCompare on a comparison model (default = NULL)

std

Whether to standardize the output (default = TRUE)

showRg

(T/F) Whether to show the genetic correlations (default = FALSE)

CIs

Whether to show Confidence intervals if they exist (default = TRUE)

report

If "html", then open an html table of the results (default = 'markdown')

returnStd

Whether to return the standardized form of the model (default = FALSE)

extended

how much to report (default = FALSE)

zero.print

How to show zeros (default = ".")

show

Here to support being called from generic xmu_safe_run_summary. User should ignore: can be c("std", "raw")

...

Other parameters to control model summary

Details

See documentation for other umx models here: umxSummary().

References

• https://tbates.github.io, https://github.com/tbates/umx

See Also

• umxSimplex()

Other Twin Modeling Functions: power.ACE.test(), umxACEcov(), umxACEv(), umxACE(), umxCP(), umxDiffMZ(), umxDiscTwin(), umxDoCp(), umxDoC(), umxGxE_window(), umxGxEbiv(), umxGxE(), umxIP(), umxMRDoC(), umxReduceACE(), umxReduceGxE(), umxReduce(), umxRotate.MxModelCP(), umxSexLim(), umxSimplex(), umxSummarizeTwinData(), umxSummaryACEv(), umxSummaryACE(), umxSummaryDoC(), umxSummaryGxEbiv(), umxSummarySexLim(), umxTwinMaker(), umx

Examples

if (FALSE) {
# 4 time model
# Select Data
data(iqdat)
mzData <- subset(iqdat, zygosity == "MZ")
dzData <- subset(iqdat, zygosity == "DZ")
vars = c("IQ_age1", "IQ_age2", "IQ_age3", "IQ_age4")
m1= umxSimplex(selDVs= vars, sep= "_T", dzData= dzData, mzData= mzData, tryHard= "yes")
umxSummary(m1, file = NA);
}