umxSummaryACE {umx}

Shows a compact, publication-style, summary of a umx Cholesky ACE model

Description

Summarize a fitted Cholesky model returned by umxACE(). 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

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

Arguments

model

an mxModel() to summarize.

digits

round to how many digits (default = 2). Defaults to NA = do not create plot output.

comparison

you can run mxCompare on a comparison model (NULL).

std

Whether to standardize the output (default = TRUE).

showRg

= whether to show the genetic correlations (FALSE).

CIs

Whether to show Confidence intervals if they exist (TRUE).

report

If "html", then open an html table of the results.

file

The name of the dot file for figure: "name" = use the name of the model.

returnStd

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

extended

how much to report (FALSE).

zero.print

How to show zeros (".")

...

Other parameters to control model summary.

Details

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

Value

• optional mxModel()

References

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

See Also

• umxACE(), plot.MxModelACE(), umxModify()

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(), umxSummaryDoC(), umxSummaryGxEbiv(), umxSummarySexLim(), umxSummarySimplex(), umxTwinMaker(), umx

Examples

## Not run: 
require(umx)
data(twinData)
selDVs = c("bmi1", "bmi2")
mzData = subset(twinData, zygosity == "MZFF")
dzData = subset(twinData, zygosity == "DZFF")
m1 = umxACE(selDVs = selDVs, dzData = dzData, mzData = mzData)
umxSummary(m1)
umxSummaryACE(m1, file = NA);
umxSummaryACE(m1, file = "name", std = TRUE)
stdFit = umxSummaryACE(m1, returnStd = TRUE);

## End(Not run)