CalmrFit-methods: CalmrFit methods

CalmrFit-methodsR Documentation

CalmrFit methods

Description

S4 methods for CalmrFit class.

Usage

## S4 method for signature 'CalmrFit'
show(object)

## S4 method for signature 'CalmrFit'
predict(object, type = "response", ...)

## S4 method for signature 'CalmrFit'
NLL(object)

## S4 method for signature 'CalmrFit'
AIC(object, k = 2)

## S4 method for signature 'CalmrFit'
BIC(object)

Arguments

object

A CalmrFit object.

type

A string specifying the type of prediction to generate.

...

Extra named arguments.

k

Penalty term for AIC method.

Details

With type = "response", the predict() function passed model responses to the link function used to fit the model.

The AIC is defined as 2*k - 2*-NLL, where k is a penalty term and NLL is the negative log likelihood of the model.

The BIC is defined as p*log(n) - 2*-NLL, where p is the number of parameters in the model and n is the number of observations

Value

  • show() returns NULL (invisibly).

  • predict() returns a numeric vector.

  • NLL() returns the negative log likelihood of the model.

  • AIC() returns the Akaike Information Criterion (AIC) of the model.

  • BIC() returns the Bayesian Information Criterion (BIC) of the model.


calmr documentation built on June 8, 2025, 1:03 p.m.