getResiduals {DHARMa}R Documentation

Get model residuals

Description

Wrapper to get the residuals of a fitted model

Usage

getResiduals(object, ...)

## S3 method for class 'MixMod'
getResiduals(object, ...)

Arguments

object

a fitted model

...

additional parameters to be passed on, usually to the residual function of the respective model class

Details

The purpose of this wrapper is to standardize extract the model residuals. Similar to some other functions, a key question is whether to calculate those conditional or unconditional on the fitted REs.

Author(s)

Florian Hartig

See Also

getObservedResponse, getSimulations, getRefit, getFixedEffects, getFitted

Examples

testData = createData(sampleSize = 400, family = gaussian())

fittedModel <- lm(observedResponse ~ Environment1 , data = testData)

# response that was used to fit the model
getObservedResponse(fittedModel)

# predictions of the model for these points
getFitted(fittedModel)

# extract simulations from the model as matrix
getSimulations(fittedModel, nsim = 2)

# extract simulations from the model for refit (often requires different structure)
x = getSimulations(fittedModel, nsim = 2, type = "refit")

getRefit(fittedModel, x[[1]])

getRefit(fittedModel, getObservedResponse(fittedModel))

[Package DHARMa version 0.4.6 Index]