dev_expl: Calculate the percent deviance explained by a GLM or GAM

View source: R/basic_stats.R

dev_explR Documentation

Calculate the percent deviance explained by a GLM or GAM

Description

This function calculates the percent deviance explained by a model, such as a generalised linear model (GLM) or generalised additive model (GAM).

Usage

dev_expl(model)

Arguments

model

A model object.

Details

Percent deviance explained is given by (model$null.deviance - model$deviance)/model$null.deviance) * 100.

Value

The function returns the percent deviance explained as a number.

Author(s)

Edward Lavender

Examples

n <- 100
x <- stats::runif(n, 0, 10)
y <- stats::rpois(n, x*2)
m1 <- stats::glm(y ~ x)
dev_expl(m1)
m2 <- mgcv::gam(y ~ s(x))
dev_expl(m2)


edwardlavender/utils.add documentation built on Dec. 14, 2024, 8:11 a.m.