old/report.lavaan.R

In easystats/report: Automated Reporting of Results and Statistical Models

#' SEM / CFA lavaan Models Report
#'
#' Create a report of a lavaan model.
#'
#' @inheritParams report.lm
#' @inheritParams parameters::model_parameters.lavaan
#' @inherit report return seealso
#'
#' @examples
#' library(report)
#' library(lavaan)
#'
#' structure <- " visual  =~ x1 + x2 + x3
#'                textual =~ x4 + x5 + x6
#'                speed   =~ x7 + x8 + x9 "
#'
#' model <- lavaan::cfa(structure, data = HolzingerSwineford1939)
#' r <- report(model)
#' r
#' summary(r)
#' as.data.frame(r)
#' summary(as.data.frame(r))
#' @export
report.lavaan <- function(model, effsize = "funder2019", ci = 0.95, standardize = TRUE, performance_metrics = "all", ...) {
  # Sanity checks -----------------------------------------------------------
  # Multiple CIs
  if (length(c(ci)) > 1) {
    warning(paste0("report does not support multiple `ci` values yet. Using ci = ", ci[1]), ".")
    ci <- ci[1]
  }

  performance <- performance::model_performance(model, metrics = performance_metrics)
  parameters <- parameters::model_parameters(model, ci = ci, standardize = standardize, ci_random = FALSE, ...)
  parameters$Link <- paste(parameters$To, parameters$Operator, parameters$From)

  table_full <- .add_performance_table(parameters, performance)
  table <- .add_performance_table(
    parameters[names(parameters) %in% c("Link", "Coefficient", "Median", "Mean", "MAP", "CI_low", "CI_high", "p", "pd", "ROPE_Percentage", "BF", "Std_Coefficient", "Std_Median", "Std_Mean", "Std_MAP", "Type")],
    performance[names(performance) %in% c("Chisq", "GFI", "AGFI", "NFI", "NNFI", "CFI", "RMSEA", "SRMR", "RFI", "PNFI", "IFI", "RNI", "AIC", "BIC", "BIC (adj.)")]
  )


  # Params
  params <- parameters
  if (standardize) {
    params$Std_Coefficient <- params$Coefficient
  }

  text <- paste0(
    text_model(model)$text,
    " ",
    text_performance(model, performance = performance),
    "\n\n",
    text_parameters(model, parameters = params[names(params)[!names(params) %in% c("SE")]])
  )
  text_full <- paste0(
    text_model(model)$text_full,
    " ",
    text_performance(model, performance = performance),
    "\n\n",
    text_parameters(model, parameters = params)
  )

  out <- list(
    text = text,
    text_full = text_full,
    table = table,
    table_full = table_full,
    values = as.list(table_full)
  )

  as.report(out)
}