umx (version 4.0.0)

umxSummaryCP: Present the results of a Common-pathway twin model in table and graphical form

Description

Summarizes a Common-Pathway model, as returned by umxCP()

Usage

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

Arguments

model

A fitted umxCP() model to summarize

digits

Round to how many digits (default = 2)

std

Whether to show the standardized model (TRUE) (ignored: used extended = TRUE to get unstandardized)

CIs

Confidence intervals (default FALSE)

showRg

Whether to show the genetic correlations (default FALSE)

comparison

Run mxCompare on a comparison model (default NULL)

report

Print tables to the console (as 'markdown'), or open in browser ('html')

file

The name of the dot file to write: NA = none; "name" = use the name of the model

returnStd

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

...

Optional additional parameters

Value

• optional mxModel()

References

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

See Also

• umxCP(), plot(), umxSummary() work for IP, CP, GxE, SAT, and ACE models.

Other Twin Reporting Functions: umxPlotCP(), umxPlotDoC(), umxReduceACE(), umxReduceGxE(), umxReduce(), umxSummarizeTwinData(), umxSummaryACEcov(), umxSummaryACEv(), umxSummaryACE(), umxSummaryDoC(), umxSummaryGxEbiv(), umxSummaryGxE(), umxSummaryIP(), umxSummarySexLim(), umxSummarySimplex(), umx

Examples

# NOT RUN {
require(umx)
umx_set_optimizer("SLSQP")
data(twinData)
twinData$wt1 = twinData$wt1/10
twinData$wt2 = twinData$wt2/10
selDVs = c("ht", "wt")
mzData = subset(twinData, zygosity == "MZFF")
dzData = subset(twinData, zygosity == "DZFF")
umx_set_auto_plot(FALSE) # turn off autoplotting for CRAN
m1 = umxCP(selDVs = selDVs, dzData = dzData, mzData = mzData, sep = "", optimizer = "SLSQP")
umxSummaryCP(m1, file = NA) # Suppress plot creation with file
umxSummary(m1, file = NA)   # Generic summary is the same
stdFit = umxSummaryCP(m1, digits = 2, std = TRUE, file = NA, returnStd = TRUE);
umxSummary(m1, std = FALSE, showRg = TRUE, file = NA);
umxSummary(m1, std = FALSE, file = NA)

# =================
# = Print example =
# =================
umxSummary(m1, file = "Figure 3", std = TRUE)

# =================
# = Confint example =
# =================
m1 = umxConfint(m1, "smart", run = FALSE);
m1 = umxConfint(m1, "smart", run = TRUE);
umxSummary(m1, CIs = TRUE, file = NA);
# }
# NOT RUN {
# }