WIP/tidy_easystats.R

In easystats/insight: Easy Access to Model Information for Various Model Objects

#' @title Tidy methods for easystats-objects
#' @name tidy
#'
#' @description Tidy methods for easystats-objects. `tidy()` usually returns
#' the same data frame that was used as input, however, with broom-alike
#' column names.
#'
#' @param x A data frame, as returned by functions from easystats-packages like
#' [`parameters:::model_parameters()`] or [`effectsize::effectsize()`].
#' @param ... Currently not used.
#'
#' @return `x`, with "standardized" column names (see [`standardize_names()`]).
#'
#' @note Due to possible namespace conflicts with other packages that define
#' a generic `tidy()`-method, the lifecycle of this function is still
#' experimental, and there might be a chance that it will become defunct and
#' removed in a future update. If possible, the preferred and stable alternative
#' to `tidy()` for \emph**easystats**-objects is `standardize_names()`.
#'
#' @examplesIf require("parameters"))
#' model <- lm(mpg ~ wt + cyl, data = mtcars)
#' mp <- model_parameters(model)
#'
#' as.data.frame(mp)
#' tidy(mp)
#' @export
tidy <- function(x, ...) {
  UseMethod("tidy")
}

#' @export
tidy.parameters_model <- function(x, ...) {
  standardize_names(x, style = "broom")
}

#' @export
tidy.effectsize_table <- tidy.parameters_model