umx (version 4.0.0)

umxSummaryACE: 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,
  file = getOption("umx_auto_plot"),
  comparison = NULL,
  std = TRUE,
  showRg = FALSE,
  CIs = TRUE,
  report = c("markdown", "html"),
  returnStd = FALSE,
  extended = FALSE,
  zero.print = ".",
  show,
  ...
)

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 = 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.

returnStd

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

extended

how much to report (FALSE).

zero.print

How to show zeros (".")

show

std, raw etc. Not implemented for umxACE yet.

...

Other parameters to control model summary.

Value

• optional mxModel()

Details

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

References

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

See Also

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

Other Twin Reporting Functions: umxPlotCP(), umxPlotDoC(), umxReduceACE(), umxReduceGxE(), umxReduce(), umxSummarizeTwinData(), umxSummaryACEcov(), umxSummaryACEv(), umxSummaryCP(), umxSummaryDoC(), umxSummaryGxEbiv(), umxSummaryGxE(), umxSummaryIP(), umxSummarySexLim(), umxSummarySimplex(), 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)
# }
# NOT RUN {
umxSummaryACE(m1, file = NA);
umxSummaryACE(m1, file = "name", std = TRUE)
stdFit = umxSummaryACE(m1, returnStd = TRUE);
# }