Skip to content

Commit

Permalink
further update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
James-Thorson committed Jul 19, 2024
1 parent 784dab0 commit cac4cdf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
9 changes: 6 additions & 3 deletions R/dsem.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 6 additions & 3 deletions man/dsem_control.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit cac4cdf

Please sign in to comment.