#' Vector of Mean Structure Parameters \eqn{\mathbf{u}}
#'
#' Derives the vector of mean structure parameters \eqn{\mathbf{u}}
#' using the Reticular Action Model (RAM) notation.
#'
#' The vector of mean structure parameters \eqn{\mathbf{v}}
#' as a function of Reticular Action Model (RAM) matrices
#' is given by
#'
#' \deqn{
#' \mathbf{u}
#' =
#' \left(
#' \mathbf{I} - \mathbf{A}
#' \right)
#' \mathbf{v} \\
#' =
#' \mathbf{E}^{-1}
#' \mathbf{v}
#' }
#'
#' where
#'
#' - \eqn{\mathbf{A}_{t \times t}} represents asymmetric paths
#' (single-headed arrows),
#' such as regression coefficients and factor loadings,
#' - \eqn{\mathbf{I}_{t \times t}} represents an identity matrix, and
#' - \eqn{\mathbf{v}_{t \times 1}} vector of expected values.
#'
#' @return \eqn{\mathbf{u} = \mathbf{E}^{-1} \mathbf{v}}
#'
#' @author Ivan Jacob Agaloos Pesigan
#'
#' @family RAM matrices functions
#' @keywords ram
#'
#' @inherit ramR references
#' @inheritParams IminusA
#' @inheritParams CheckRAMMatrices
#' @export
u <- function(A,
v,
check = TRUE,
...) {
UseMethod("u")
}
#' @rdname u
#' @inheritParams IminusA.default
#' @inheritParams u
#' @examples
#' # Numeric -----------------------------------------------------------
#' # This is a numerical example for the model
#' # y = alpha + beta * x + e
#' # y = 0 + 1 * x + e
#' #--------------------------------------------------------------------
#'
#' A <- matrixR::ZeroMatrix(3)
#' A[1, ] <- c(0, 1, 1)
#' v <- c(0.50, 0.50, 0.00)
#' colnames(A) <- rownames(A) <- c("y", "x", "e")
#' u(A, v)
#' @export
u.default <- function(A,
v,
check = TRUE,
...) {
if (check) {
RAM <- CheckRAMMatrices(
A = A,
v = v
)
A <- RAM$A
v <- RAM$v
}
IminusA <- IminusA(
A = A,
check = FALSE
)
u <- as.matrix(IminusA %*% v)
colnames(u) <- "u"
return(u)
}
#' @rdname u
#' @inheritParams IminusA.yac_symbol
#' @inheritParams u
#' @examples
#' # Symbolic ----------------------------------------------------------
#' # This is a symbolic example for the model
#' # y = alpha + beta * x + e
#' # y = 0 + 1 * x + e
#' #--------------------------------------------------------------------
#'
#' A <- matrixR::ZeroMatrix(3)
#' A[1, ] <- c(0, "beta", 1)
#' v <- c("alpha+beta*mux", "mux", 0)
#' u(Ryacas::ysym(A), v)
#' u(Ryacas::ysym(A), v, format = "str")
#' u(Ryacas::ysym(A), v, format = "tex")
#' u(Ryacas::ysym(A), v, R = TRUE)
#'
#' # Assigning values to symbols
#'
#' alpha <- 0
#' beta <- 1
#' mux <- 0.50
#'
#' u(Ryacas::ysym(A), v)
#' u(Ryacas::ysym(A), v, format = "str")
#' u(Ryacas::ysym(A), v, format = "tex")
#' u(Ryacas::ysym(A), v, R = TRUE)
#' eval(u(Ryacas::ysym(A), v, R = TRUE))
#' @export
u.yac_symbol <- function(A,
v,
check = TRUE,
exe = TRUE,
R = FALSE,
format = "ysym",
simplify = FALSE,
...) {
if (check) {
v <- CheckRAMMatrices(
A = A,
v = v
)$v
} else {
v <- yacR::as.ysym.mat(v)
}
expr <- paste0(
"Identity(", "
Length(",
A,
")",
")",
"*",
v
)
if (exe) {
return(
yacR::Exe(
expr,
R = R,
format = format,
simplify = simplify
)
)
} else {
return(expr)
}
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.