Residual.poisres: Calculates the Residuals for a completed poisson model

View source: R/BasicRun.R

Residual.poisresR Documentation

Calculates the Residuals for a completed poisson model

Description

Residual.poisres uses user provided data, person-year/event columns, vectors specifying the model, and options to calculate residuals for a solved Poisson regression

Usage

## S3 method for class 'poisres'
Residual(
  x,
  df,
  control = list(),
  a_n = c(),
  pearson = FALSE,
  deviance = FALSE,
  ...
)

Arguments

x

result object from a regression, class poisres

df

a data.table containing the columns of interest

control

list of parameters controlling the convergence, see the Control_Options vignette for details

a_n

list of initial parameter values, used to determine the number of parameters. May be either a list of vectors or a single vector.

pearson

boolean to calculate pearson residuals

deviance

boolean to calculate deviance residuals

...

can include the named entries for the assign_control list parameter

Value

returns a list of the final results

See Also

Other Poisson Wrapper Functions: EventAssignment.poisres(), EventAssignment.poisresbound(), LikelihoodBound.poisres(), PoisRun(), PoisRunJoint(), PoisRunMulti()


Colossus documentation built on Feb. 20, 2026, 5:10 p.m.