diff --git a/DESCRIPTION b/DESCRIPTION index 419b5b7df..e01f37595 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -76,7 +76,7 @@ VignetteBuilder: Encoding: UTF-8 Language: en-US Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.2 +RoxygenNote: 7.3.3 Config/testthat/edition: 3 Config/testthat/parallel: true Config/Needs/website: easystats/easystatstemplate diff --git a/R/describe_distribution.R b/R/describe_distribution.R index 4ee3cac4f..74dcce4d8 100644 --- a/R/describe_distribution.R +++ b/R/describe_distribution.R @@ -1,7 +1,7 @@ #' Describe a distribution #' #' This function describes a distribution by a set of indices (e.g., measures of -#' centrality, dispersion, range, skewness, kurtosis). +#' centrality, dispersion, range, skewness, (excess) kurtosis). #' #' @param x A numeric vector, a character vector, a data frame, or a list. See #' `Details`. @@ -41,6 +41,8 @@ #' [`plot()`-method](https://easystats.github.io/see/articles/parameters.html) #' implemented in the [**see**-package](https://easystats.github.io/see/). #' +#' @seealso [kurtosis()] to compute kurtosis (recognized as excess kurtosis). +#' #' @return A data frame with columns that describe the properties of the variables. #' #' @examplesIf require("bayestestR", quietly = TRUE) diff --git a/man/adjust.Rd b/man/adjust.Rd index edc01ada2..1574636e6 100644 --- a/man/adjust.Rd +++ b/man/adjust.Rd @@ -128,7 +128,7 @@ Note that a regular correlation between two "adjusted" variables is equivalent to the partial correlation between them. } \examples{ -\dontshow{if (all(insight::check_if_installed(c("bayestestR", "rstanarm", "gamm4"), quietly = TRUE))) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (all(insight::check_if_installed(c("bayestestR", "rstanarm", "gamm4"), quietly = TRUE))) withAutoprint(\{ # examplesIf} adjusted_all <- adjust(attitude) head(adjusted_all) adjusted_one <- adjust(attitude, effect = "complaints", select = "rating") diff --git a/man/contr.deviation.Rd b/man/contr.deviation.Rd index d9d378429..fa4e10bf7 100644 --- a/man/contr.deviation.Rd +++ b/man/contr.deviation.Rd @@ -49,7 +49,7 @@ the differences the \strong{A} and \strong{B} group means from the overall mean, respectively. } \examples{ -\dontshow{if (!identical(Sys.getenv("IN_PKGDOWN"), "true")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (!identical(Sys.getenv("IN_PKGDOWN"), "true")) withAutoprint(\{ # examplesIf} \donttest{ data("mtcars") diff --git a/man/data_group.Rd b/man/data_group.Rd index bc26bf068..572ff8b3a 100644 --- a/man/data_group.Rd +++ b/man/data_group.Rd @@ -90,7 +90,7 @@ following the \strong{datawizard} function design. \code{data_ungroup()} removes grouping information from a grouped data frame. } \examples{ -\dontshow{if (requireNamespace("poorman")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (requireNamespace("poorman")) withAutoprint(\{ # examplesIf} data(efc) suppressPackageStartupMessages(library(poorman, quietly = TRUE)) diff --git a/man/data_tabulate.Rd b/man/data_tabulate.Rd index 9adb869a7..75b3fd1e1 100644 --- a/man/data_tabulate.Rd +++ b/man/data_tabulate.Rd @@ -223,7 +223,7 @@ for the full table. } \examples{ -\dontshow{if (requireNamespace("poorman")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (requireNamespace("poorman")) withAutoprint(\{ # examplesIf} # frequency tables ------- # ------------------------ data(efc) diff --git a/man/data_to_long.Rd b/man/data_to_long.Rd index b3dd9c08d..697ae9af0 100644 --- a/man/data_to_long.Rd +++ b/man/data_to_long.Rd @@ -159,7 +159,7 @@ names, that identify the source of the gathered values, stored in one or more new columns (\code{names_to}). } \examples{ -\dontshow{if (all(insight::check_if_installed(c("psych", "tidyr"), quietly = TRUE))) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (all(insight::check_if_installed(c("psych", "tidyr"), quietly = TRUE))) withAutoprint(\{ # examplesIf} wide_data <- setNames( data.frame(replicate(2, rnorm(8))), c("Time1", "Time2") diff --git a/man/data_to_wide.Rd b/man/data_to_wide.Rd index 8281dcce0..7389b4927 100644 --- a/man/data_to_wide.Rd +++ b/man/data_to_wide.Rd @@ -124,7 +124,7 @@ saved into the column \code{values_from} will be spread into new columns, which will be named after the values in \code{names_from}. See also 'Examples'. } \examples{ -\dontshow{if (requireNamespace("lme4", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (requireNamespace("lme4", quietly = TRUE)) withAutoprint(\{ # examplesIf} data_long <- read.table(header = TRUE, text = " subject sex condition measurement 1 M control 7.9 diff --git a/man/describe_distribution.Rd b/man/describe_distribution.Rd index a8cdca879..b7702f668 100644 --- a/man/describe_distribution.Rd +++ b/man/describe_distribution.Rd @@ -152,7 +152,7 @@ A data frame with columns that describe the properties of the variables. } \description{ This function describes a distribution by a set of indices (e.g., measures of -centrality, dispersion, range, skewness, kurtosis). +centrality, dispersion, range, skewness, (excess) kurtosis). } \details{ If \code{x} is a data frame, only numeric variables are kept and will be @@ -171,7 +171,7 @@ There is also a implemented in the \href{https://easystats.github.io/see/}{\strong{see}-package}. } \examples{ -\dontshow{if (require("bayestestR", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (require("bayestestR", quietly = TRUE)) withAutoprint(\{ # examplesIf} describe_distribution(rnorm(100)) data(iris) @@ -180,3 +180,6 @@ describe_distribution(iris, include_factors = TRUE, quartiles = TRUE) describe_distribution(list(mtcars$mpg, mtcars$cyl)) \dontshow{\}) # examplesIf} } +\seealso{ +\code{\link[=kurtosis]{kurtosis()}} to compute kurtosis (recognized as excess kurtosis). +} diff --git a/man/rescale_weights.Rd b/man/rescale_weights.Rd index b2a329a3e..ce7039827 100644 --- a/man/rescale_weights.Rd +++ b/man/rescale_weights.Rd @@ -101,7 +101,7 @@ standard survey-design. } } \examples{ -\dontshow{if (all(insight::check_if_installed(c("lme4", "parameters"), quietly = TRUE))) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (all(insight::check_if_installed(c("lme4", "parameters"), quietly = TRUE))) withAutoprint(\{ # examplesIf} data(nhanes_sample) head(rescale_weights(nhanes_sample, "WTINT2YR", "SDMVSTRA"))