is.GNARfit: Function to check GNARfit objects

View source: R/is.GNARfit.R

is.GNARfitR Documentation

Function to check GNARfit objects

Description

is.GNARfit returns either TRUE or FALSE according to a series of GNARfit checks.

Usage

is.GNARfit(x)

Arguments

x

the object to be tested

Details

The is.GNARfit function checks whether the object passes a series of tests that correspond to it being the output of GNARfit:

  • Is it a list containing $mod and $frbic

  • Does it contain either $y and $dd or $ys and $ds

  • Is $mod a lm object

  • Does $frbic have the components to calculate the BIC with BIC.GNARfit

Value

is.GNARfit returns TRUE or FALSE corresponding to passing the above tests.

Examples

#check that the example fit meets the criteria above
is.GNARfit(GNARfit())

GNAR documentation built on April 28, 2023, 1:12 a.m.

Related to is.GNARfit in GNAR...