R/tidy_logLik.R

In quantPsych/RMediation: Mediation Analysis Confidence Intervals

#' Creates a data.frame for a log-likelihood object
#'
#' @param x x A log-likelihood object, typically returned by [logLik].
#' @param ... Additional arguments (not used)
#' @return A [data.frame] with columns:
#'  \describe{
#'  \item{term}{The term name}
#'  \item{estimate}{The log-likelihood value}
#'  \item{df}{The degrees of freedom}
#'  }
#' @author Davood Tofighi \email{dtofighi@@gmail.com}
#' @name tidy.logLik
#' @rdname tidy_logLik
#' @seealso \code{\link[stats]{logLik}}
#' @importFrom stats logLik
#' @importFrom generics tidy
#' @export
#' @author Davood Tofighi \email{dtofighi@@gmail.com}
#' @examples
#' fit <- lm(mpg ~ wt, data = mtcars)
#' logLik_fit <- logLik(fit)
#' tidy(logLik_fit)
tidy.logLik <- function(x, ...) {
  logLik_value <- as.numeric(x)
  df <- attr(x, "df")

  tidy_df <- data.frame(
    term = "logLikelihood",
    estimate = logLik_value,
    df = df,
    stringsAsFactors = FALSE
  )

  return(tidy_df)
}