ggstatsplot (version 0.0.9)

normality_message: Display normality test result as a message.

Description

A note to the user about the validity of assumptions for the default linear model.

Usage

normality_message(x, lab = NULL, k = 2, output = "message", ...)

Arguments

x

A numeric vector.

lab

A character describing label for the variable. If NULL, a generic "x" label will be used.

k

Number of digits after decimal point (should be an integer) (Default: k = 2).

output

What output is desired: "message" (default) or "stats" (or "tidy") objects.

...

Additional arguments (ignored).

Value

A list with class "htest" containing the following components:

statistic

the value of the Shapiro-Wilk statistic.

p.value

an approximate p-value for the test. This is said in Royston (1995) to be adequate for p.value < 0.1.

method

the character string "Shapiro-Wilk normality test".

data.name

a character string giving the name(s) of the data.

See Also

ggbetweenstats

Other helper_messages: bartlett_message, effsize_ci_message, ggcorrmat_matrix_message, grouped_message, pairwise_p, palette_message

Examples

# NOT RUN {
# message
normality_message(
  x = anscombe$x1,
  lab = "x1",
  k = 3
)

# statistical test object
ggstatsplot::normality_message(
  x = anscombe$x2,
  output = "tidy"
)
# }