From cac4cdf030fc62c537895085ef84b8a700de4319 Mon Sep 17 00:00:00 2001 From: Jim Thorson Date: Fri, 19 Jul 2024 11:01:52 -0700 Subject: [PATCH] further update docs --- R/dsem.R | 9 ++++++--- man/dsem_control.Rd | 9 ++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/R/dsem.R b/R/dsem.R index a2a186b..f3a197d 100644 --- a/R/dsem.R +++ b/R/dsem.R @@ -344,16 +344,19 @@ function( sem, #' this using the inverse-cholesky of the precision, where this projection #' can be rank-deficient. #' @param constant_variance Whether to specify a constant conditional variance -#' \eqn{ \mathbf{Gamma Gamma}^t} using the default \code{constant_variance="conditional"}, +#' \eqn{ \mathbf{\Gamma \Gamma}^t} using the default \code{constant_variance="conditional"}, #' which results in a changing marginal variance #' along the specified causal graph when lagged paths are present. Alternatively, the user can #' specify a constant marginal variance using \code{constant_variance="diagonal"} #' or \code{constant_variance="marginal"}, -#' such that \eqn{ \mathbf{Gamma}} and \eqn{\mathbf{I-P}} are rescaled to achieve this constraint. +#' such that \eqn{ \mathbf{\Gamma}} and \eqn{\mathbf{I-P}} are rescaled to achieve this constraint. #' All options #' are equivalent when the model includes no lags (only simultaneous effects) and #' no covariances (no two-headed arrows). \code{"diagonal"} and \code{"marginal"} -#' are equivalent when the model includes no covariances. +#' are equivalent when the model includes no covariances. Given some exogenous covariance, +#' \code{constant_variance = "marginal"} preserves the conditional correlation and has +#' changing conditional variance, while \code{constant_variance = "marginal"} has changing +#' conditional correlation along the causal graph. #' @param quiet Boolean indicating whether to run model printing messages to terminal or not; #' @param use_REML Boolean indicating whether to treat non-variance fixed effects as random, #' either to motigate bias in estimated variance parameters or improve efficiency for diff --git a/man/dsem_control.Rd b/man/dsem_control.Rd index 9bfc56c..20b2a9b 100644 --- a/man/dsem_control.Rd +++ b/man/dsem_control.Rd @@ -54,16 +54,19 @@ this using the inverse-cholesky of the precision, where this projection can be rank-deficient.} \item{constant_variance}{Whether to specify a constant conditional variance -\eqn{ \mathbf{Gamma Gamma}^t} using the default \code{constant_variance="conditional"}, +\eqn{ \mathbf{\Gamma \Gamma}^t} using the default \code{constant_variance="conditional"}, which results in a changing marginal variance along the specified causal graph when lagged paths are present. Alternatively, the user can specify a constant marginal variance using \code{constant_variance="diagonal"} or \code{constant_variance="marginal"}, -such that \eqn{ \mathbf{Gamma}} and \eqn{\mathbf{I-P}} are rescaled to achieve this constraint. +such that \eqn{ \mathbf{\Gamma}} and \eqn{\mathbf{I-P}} are rescaled to achieve this constraint. All options are equivalent when the model includes no lags (only simultaneous effects) and no covariances (no two-headed arrows). \code{"diagonal"} and \code{"marginal"} -are equivalent when the model includes no covariances.} +are equivalent when the model includes no covariances. Given some exogenous covariance, +\code{constant_variance = "marginal"} preserves the conditional correlation and has +changing conditional variance, while \code{constant_variance = "marginal"} has changing +conditional correlation along the causal graph.} \item{use_REML}{Boolean indicating whether to treat non-variance fixed effects as random, either to motigate bias in estimated variance parameters or improve efficiency for