Summarize Eigenvalues and Eigenvectors of a Covariance Matrix

This function computes the eigenvalues and eigenvectors of a given covariance matrix, ensures sign consistency in the eigenvectors, and outputs either a LaTeX table or plaintext summary displaying the results.

Usage

eigen.summary(
  cov.matrix,
  caption = "Eigenvectors of Covariance Matrix",
  space_after_caption = "5mm",
  latex = TRUE
)

Arguments

cov.matrix: A square numeric matrix representing the covariance matrix.
caption: A character string specifying the table caption (default: "Eigenvectors of Covariance Matrix").
space_after_caption: A character string specifying the space after the caption in LaTeX (default: "5mm").
latex: A logical indicating whether to output LaTeX table (default: TRUE). If FALSE, prints as plain text.

Value

A LaTeX formatted table (if latex = TRUE) or plaintext console output (if latex = FALSE).

Examples

cov_matrix <- matrix(c(4, 2, 2, 3), nrow = 2)
eigen.summary(cov_matrix, caption = "Eigenvalues and Eigenvectors of Covariance Matrix", latex = FALSE)
#> == Eigenvalues and Eigenvectors of Covariance Matrix ==
#> 
#> Eigenvalues:
#> [1] 5.56155 1.43845
#> 
#> Eigenvectors (columns correspond to eigenvalues):
#> 
#>  lambda1    lambda2
#> --------  ---------
#>  0.78821   -0.61541
#>  0.61541    0.78821
#> 
#> Total Variance: 7