Skip to contents

The P-Value of the F Test of R-square as Text

text_rsq_p.Rd

Extracts the p-value of the F statistics of the R-square from an object and returns it as a text string.

Usage

text_rsq_p(x, ...)

# S3 method for default
text_rsq_p(
  x,
  digits = getOption("out2text_test_p_digits", 3),
  format = getOption("out2text_test_p_format", "f"),
  italics = FALSE,
  ...
)

# S3 method for lm
text_rsq_p(
  x,
  digits = getOption("out2text_test_p_digits", 3),
  format = getOption("out2text_test_p_format", "f"),
  italics = FALSE,
  ...
)

Arguments

x

A supported object with a F statistic the results.

...

Optional arguments. Ignored for now.

digits

The number of decimal places to keep. To be passed to formatC().

format

The format string used in formatC(). Default is "f".

italics

Logical. Whether the statistics should be italicized (using markdown). Default is FALSE.

Value

A one-element character vector.

Details

Details (Include subjects for verbs.) (Use 3rd person forms for verbs.)

Author

Shu Fai Cheung https://orcid.org/0000-0002-9871-9448

Examples


set.seed(894252)
n <- 10
x <- rnorm(n)
y <- .6 * x + rnorm(n, 0, .8)
out <- lm(y ~ x)
text_rsq_p(out)
#> [1] "p = 0.007"