variable.names: Variable Names in FCS2 Model

Description Usage Arguments Value See Also

Description

Returns a vector of selected variables in an FCS2 model.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## S3 method for class 'fcs2Fit'
variable.names(
  object,
  q = object$multiRun,
  r = TRUE,
  abundance = TRUE,
  prevalence = TRUE,
  linear = TRUE,
  rw = "group",
  spatial = "group",
  hyperparams = "scale",
  ...
)

Arguments

object

an object of class "fcs2Fit", usually returned by fcs2FitModel.

q

whether to include the catch probability variable q.

r

whether to include the shape parameter r (given by size in dzinbinom and dzinmultinom).

abundance

whether to include any variables related to the abundance regression.

prevalence

whether to include any variables related to the prevalence regression.

linear

whether to include linear regression terms.

rw

whether and how to include random walk terms. If TRUE or "group", a single variable name is returned for each random walk term. If "singluar", each individual variable is included.

spatial

whether and how to include spatial terms. If TRUE or "group", a single variable name is returned for each spatial term. If "singluar", each individual variable is included.

hyperparams

whether and how to include hyperparameters. If "scale", scale hyperparameters (σ or ν) are included. If "precision", hyperparameters are specified on the precision scale (τ or φ).

...

Not currently used.

Value

A character vector of selected variables in the FCS2 model specified by object.

See Also

fcs2FitModel for fitting the FCS2 model.


aquaMetrics/fcs2 documentation built on Aug. 21, 2021, 12:55 p.m.