A R-square as Text — text

Extracts the R-square from an object and returns it as a text string.

Usage

text_rsq(x, ...)

# S3 method for default
text_rsq(
  x,
  digits = getOption("out2text_coef_digits", 3),
  format = getOption("out2text_coef_format", "f"),
  ...
)

# S3 method for lm
text_rsq(
  x,
  digits = getOption("out2text_coef_digits", 3),
  format = getOption("out2text_coef_format", "f"),
  type = c("unadjusted", "adjusted"),
  ...
)

Arguments

x: A supported object with an R-square in 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".
type: The type of R-squared to be extracted. Either "unadjusted", the default, or "adjusted", which returns the adjusted R-squared.

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(out)
#> [1] "0.624"