get.par: Extract estimated or fixed parameter values from an 'ascr'...

View source: R/helpers.r

get.parR Documentation

Extract estimated or fixed parameter values from an ascr model fit

Description

Extracts estimated, derived, and fitted parameters from a model fitted using fit.ascr.

Usage

get.par(fit, pars = "all", cutoff = FALSE, as.list = FALSE)

Arguments

fit

A fitted model from fit.ascr.

pars

A character vector containing names of parameter values to be extracted. Alternatively, the character string "all" will extract all parameters, fixed or otherwise, and the character string "fitted" extracts only fitted parameters (i.e., not the effective survey area). See the 'Details' section for the fit.ascr function's documentation for information on the parameters that are fitted.

cutoff

Logical, if TRUE, the cutoff value for an acoustic fit is included.

as.list

Logical, if TRUE, each parameter value is returned as the component of a list, where component names give the parameter names. In this case, the returned object is suitable as the argument of a variety of functions (e.g., sv or fix for the fit.ascr function, or pars for the sim.capt function). If FALSE, parameter values are returned as part of a named vector.

Details

This is a similar function to coef.ascr, however get.par also allows for extraction of parameters that have been fixed using fit.ascr's fix argument.

Value

See above information about the argument as.list. If as.list is TRUE, then a list is returned. If as.list is FALSE, then a named character vector is returned.

Examples

get.par(fit = example.data$fits$simple.hn, pars = "all")
get.par(fit = example.data$fits$bearing.hn, pars = c("D", "kappa", "esa"), as.list = TRUE)


b-steve/ascr documentation built on Aug. 15, 2022, 2:38 p.m.