sr {FLCore} | R Documentation |
Stock-recruitment model function
Description
The sr()
function acts as a front end to the various functions available
that implement various stocker/recruitment models. Four models are provided in
this package, but it is possible to write new functions that make use of the sr
call mechanism (see below).
Usage
sr(data, ...)
Arguments
data |
An FLSR object holding the stock and recruitment data (slots r and ssb). |
... |
Other parameters, depending on the model selected. |
Details
Four commonly used stock-recruitment models are available in this package:
"ricker":Application of the classical Ricker model.
"bevholt":Application of the classical Beverton-Holt model
"segreg":Application of the segmented regression/hockey-stick model.
"qhstk":Application of the quadratic hockey-stick model.
The calling mechanism provided by sr
allows for other models to be implemented.
They would also be called from sr
as long as they comply with the input/output
interface:
inputBoth recruitment and SSB will be provided to the model function as vectors
of the same length as the number of years present in the original FLQuants. No
interface is provided as yet for models able to estimate S/R relationships by area
or season. Bayesian models are expected to accept a list with the required prior
parameter probability distributions. The name of a Bayesian model must contain the
string "Bayes".
outputThe result returned by the function should consist of a list with named
pairs matching the corresponding slots of a FLSR-class
object. Class of
objects in this list must match those of the FLSR-class
slots. For example,
residuals must be a FLQuant-class
.
Value
An object of class FLSR-class
Note
Author(s)
Richard Hillary and Iago Mosqueira
References
See Also
FLSR-class
Examples
[Package
FLCore version 1.1
Index]