summary.s2bak: Generate summary statistics for s2bak objects

In leung-lab/s2bak: Fit species distribution models for multiple using the S2BaK framework.

Generate summary statistics for s2bak objects

Description

This function will allow the user to call the summary function for s2bak, s2bak.so, s2bak.s2 and s2bak.bak class objects.

This model assumes that the model used in the fitting process has an associated summary function associated with it.

As these models may be fitted for multiple species or sub-models, the user can specify which index or species to view.

Usage

## S3 method for class 's2bak.s2'
summary(object, species, ...)

## S3 method for class 's2bak.so'
summary(object, species, ...)

## S3 method for class 's2bak.bak'
summary(
  object,
  bak = c("all", "bias_site", "bias_species", "bias_adj")[1],
  ...
)

## S3 method for class 's2bak'
summary(
  object,
  submodel = c("all", "so", "s2", "bak")[1],
  species = NULL,
  bak = c("all", "bias_site", "bias_species", "bias_adj")[1],
  ...
)

Arguments

object	Object of class s2bak, s2bak.so, s2bak.s2ors2bak.bak'.
species	For s2bak.so, s2bak.s2 and s2bak models. The character name of the species to access the model, or the index if an integer is provided.
...	Additional arguments provided by the object's summary function.
bak	For s2bak.bak and s2bak models. Select which of the three submodels to display, or all of them (default bak = "all").
submodel	Which submodel (s2bak.so, s2bak.s2 or s2bak.bak) to display (default submodel = "all", which displays all of them). Note that species must be specified if attempting a summary of s2bak.so or s2bak.s2 models.

Value

The relevant summary output for a given species.

leung-lab/s2bak documentation built on March 1, 2023, 9:10 a.m.