Skip to contents

extract method for bam objects

Source: R/extract.R
extract-bam-method.Rd

extract method for bam objects created by the bam function in the mgcv package.

Usage

# S4 method for class 'bam'
extract(
  model,
  include.smooth = TRUE,
  include.aic = TRUE,
  include.bic = TRUE,
  include.loglik = TRUE,
  include.deviance = TRUE,
  include.dev.expl = TRUE,
  include.dispersion = TRUE,
  include.rsquared = TRUE,
  include.gcv = TRUE,
  include.nobs = TRUE,
  include.nsmooth = TRUE,
  ...
)

Arguments

model

A statistical model object.

include.smooth

Report the smooth terms of a GAM? If they are reported, the EDF value is reported as the coefficient, and DF is included in parentheses (not standard errors because a chi-square test is used for the smooth terms).

include.aic

Report Akaike's Information Criterion (AIC) in the GOF block?

include.bic

Report the Bayesian Information Criterion (BIC) in the GOF block?

include.loglik

Report the log likelihood in the GOF block?

include.deviance

Report the deviance?

include.dev.expl

Report the deviance explained?

include.dispersion

Report the dispersion parameter?

include.rsquared

Report R^2 in the GOF block?

include.gcv

Report the GCV score?

include.nobs

Report the number of observations in the GOF block?

include.nsmooth

Report the number of smooth terms?

...

Custom parameters, which are handed over to subroutines, in this case to the summary method for the object.