Build a Temporal Pedigree mxModel

Wrapper around buildPedigreeMx with temporal = TRUE.

Usage

buildTemporalPedigreeMx(
  model_name,
  group_models,
  p_hist,
  components = c("a", "e"),
  ci = FALSE,
  time_point_max = NULL,
  start_beta0 = 0.5,
  start_beta_time = 0,
  start_gamma = 0,
  mean_degree = 0,
  start_mean = 0,
  mean_hist_free = FALSE,
  start_mean_hist = 0
)

Arguments

model_name

Name of the overall pedigree model.

group_models

A list of OpenMx models for each family group.

p_hist

Integer. Number of historical moderator columns.

components

Character vector of component keys to include (any of "a", "d", "cn", "ce", "mt", "am", "e"). Only used when temporal = TRUE. Default is c("a", "e").

ci

Logical. If TRUE, include confidence interval computations for the variance components. Default is FALSE

time_point_max

Integer degree of the polynomial birth-year basis. Only used when temporal = TRUE. Default is 3.

start_beta0

Numeric. Starting value for each component's intercept loading. Only used when temporal = TRUE. Default is 0.5.

start_beta_time

Numeric. Starting value for each component's time-slope loadings. Only used when temporal = TRUE. Default is 0.

start_gamma

Numeric. Starting value for historical-moderator loadings. Only used when temporal = TRUE. Default is 0.

mean_degree

Integer. Degree of the polynomial temporal mean. The default, 0, estimates a constant mean. Must not exceed time_point_max.

start_mean

Numeric. Starting value for the mean's intercept. Set this near the observed phenotype mean.

mean_hist_free

Logical, length 1 or p_hist. Whether historical moderators can shift the phenotypic mean. Defaults to FALSE, fixing those shifts at zero.

start_mean_hist

Numeric. Starting value for the free elements of G_mean.

Value

An OpenMx pedigree model combining the temporal covariance sub-model and family groups.