diff --git a/WIP/tidy_easystats.R b/WIP/tidy_easystats.R index 4bc87574e..37d79f352 100644 --- a/WIP/tidy_easystats.R +++ b/WIP/tidy_easystats.R @@ -1,29 +1,28 @@ #' @title Tidy methods for easystats-objects #' @name tidy #' -#' @description Tidy methods for easystats-objects. \code{tidy()} usually returns -#' the same data frame that was used as input, however, with broom-alike -#' column names. +#' @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 \code{\link[parameters:model_parameters]{model_parameters()}} or \code{\link[effectsize:effectsize]{effectsize()}}. +#' @param x A data frame, as returned by functions from easystats-packages like +#' [`parameters:::model_parameters()`] or [`effectsize::effectsize()`]. #' @param ... Currently not used. #' -#' @return \code{x}, with "standardized" column names (see \code{\link{standardize_names}}). +#' @return `x`, with "standardized" column names (see [`standardize_names()`]). #' #' @note Due to possible namespace conflicts with other packages that define -#' a generic \code{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 \code{tidy()} for \emph**easystats**-objects is \code{\link{standardize_names}}. +#' 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()`. #' -#' @examples -#' if (require("parameters")) { -#' model <- lm(mpg ~ wt + cyl, data = mtcars) -#' mp <- model_parameters(model) +#' @examplesIf require("parameters")) +#' model <- lm(mpg ~ wt + cyl, data = mtcars) +#' mp <- model_parameters(model) #' -#' as.data.frame(mp) -#' tidy(mp) -#' } +#' as.data.frame(mp) +#' tidy(mp) #' @export tidy <- function(x, ...) { UseMethod("tidy")