FLXSA.control: Create a new FLXSA.control object
In FLXSA: eXtended Survivor Analysis for FLR

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/FLXSA.R

This function creates a new control object required by XSA model (extended survivors analysis).

1
2
3

FLXSA.control(x = NULL, tol = 1e-09, maxit = 30, min.nse = 0.3, fse = 0.5,
    rage = 0, qage = 10, shk.n = TRUE, shk.f = TRUE, shk.yrs = 5,
    shk.ages = 5, window = 100, tsrange = 20, tspower = 3, vpa = FALSE)

`x`	An object of class FLXSA. If provided, the 'FLXSA.control' is initialized with the corresponding values of an XSA analysis stored in the object. This is useful for getting the same initial parameters for successive analyses. Specifying one or more of the other arguments supersedes default values, or values obtained from this FLXSA object
`tol`	The covergence tolerance, i.e. difference between two successive iterations must be lower, to declare convergence of the model.
`maxit`	The maximum number of iterations allowed
`min.nse`	The minimum value of SE permitted in estimate of N hat
`fse`	User set SE of F when shrinking to mean F
`rage`	The oldest age for which the two parameter model is used for catchability at age. Note that this value should be one less than the value used in the executable version of XSA
`qage`	The age after which catchability is no longer estimated. q at older ages set to the value at this age
`shk.n`	If `TRUE`, shrinkage to mean N
`shk.f`	If `TRUE`, shrinkage to mean F
`shk.yrs`	The number of years to be used for shrinkage to F for terminal year
`shk.ages`	The number of ages to be used for shrinkage to F for terminal age
`window`	The time window to consider in the model
`tsrange`	The number of years to be used in the time series weighting
`tspower`	The power to be used in the time series taper weighting
`vpa`	If `FALSE` use cohort analysis, otherwise, use VPA

See FLXSA for more details about the method and some bibliographical references.

An FLXSA.control object with same slots as the arguments of the function (except FLXSA)

Laurence Kell & Philippe Grosjean

FLXSA

	# To create a new FLXSA.control object with default parameters:
	my.xsa.control <- FLXSA.control()
	my.xsa.control
	# Same, but changing values of some parameters
	my.xsa.control <- FLXSA.control(maxit=50, shk.f=FALSE)
	my.xsa.control