performance: r2 – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

r2

Compute the model's R2

Description

Calculate the R2, also known as the coefficient of determination, value for different model objects. Depending on the model, R2, pseudo-R2, or marginal / adjusted R2 values are returned.

Usage

r2(model, ...)

## S3 method for class 'merMod'
r2(model, tolerance = 1e-05, ...)

Arguments

`model`	A statistical model.
`...`	Arguments passed down to the related r2-methods.
`tolerance`	Tolerance for singularity check of random effects, to decide whether to compute random effect variances for the conditional r-squared or not. Indicates up to which value the convergence result is accepted. When `r2_nakagawa()` returns a warning, stating that random effect variances can't be computed (and thus, the conditional r-squared is `NA`), decrease the tolerance-level. See also `check_singularity`.

Value

Returns a list containing values related to the most appropriate R2 for the given model. See the list below:

Logistic models: Tjur's R2
General linear models: Nagelkerke's R2
Multinomial Logit: McFadden's R2
Models with zero-inflation: R2 for zero-inflated models
Mixed models: Nakagawa's R2
Bayesian models: R2 bayes

Note

If there is no r2()-method defined for the given model class, r2() tries to return a "generic r2 value, calculated as following: 1-sum((y-y_hat)^2)/sum((y-y_bar)^2))

Examples

model <- glm(vs ~ wt + mpg, data = mtcars, family = "binomial")
r2(model)

if (require("lme4")) {
  model <- lmer(Sepal.Length ~ Petal.Length + (1 | Species), data = iris)
  r2(model)
}

performance

Assessment of Regression Models Performance

v0.7.1

GPL-3

Authors

Daniel Lüdecke [aut, cre] (<https://orcid.org/0000-0002-8895-3206>), Dominique Makowski [aut, ctb] (<https://orcid.org/0000-0001-5375-9967>), Mattan S. Ben-Shachar [aut, ctb] (<https://orcid.org/0000-0002-4287-4801>), Indrajeet Patil [aut, ctb] (<https://orcid.org/0000-0003-1995-6531>), Philip Waggoner [aut, ctb] (<https://orcid.org/0000-0002-7825-7573>), Vincent Arel-Bundock [ctb] (<https://orcid.org/0000-0003-2042-7063>)

Initial release

r2